Index: ebuild-writing/common-mistakes/text.xml =================================================================== --- ebuild-writing/common-mistakes/text.xml (revision 114) +++ ebuild-writing/common-mistakes/text.xml (working copy) @@ -19,6 +19,28 @@ the dynamic and static libraries. + +
+Referencing the full path to documentation files that could be +compressed + +When printing out to the users where to find files like INSTALL, do not specify +the full path since PORTAGE_COMPRESS comes into play. The file could be +compressed with gzip, bzip2, or some other random compression tool. So, +instead of doing this: + + +elog "They are listed in /usr/share/doc/${PF}/INSTALL.gz" + + +Do something like: + + +elog "They are listed in the INSTALL file in /usr/share/doc/${PF}" + + +
+