Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
View | Details | Raw Unified | Return to bug 169772 | Differences between
and this patch

Collapse All | Expand All

(-)ebuild-writing/common-mistakes/text.xml (+22 lines)
Lines 19-24 Link Here
19
the dynamic and static libraries.
19
the dynamic and static libraries.
20
</body>
20
</body>
21
</section>
21
</section>
22
23
<section>
24
<title>Referencing the full path to documentation files that could be
25
compressed</title>
26
<body>
27
When printing out to the users where to find files like INSTALL, do not specify
28
the full path since <c>PORTAGE_COMPRESS</c> comes into play.  The file could be
29
compressed with gzip, bzip2, or some other random compression tool.  So,
30
instead of doing this:
31
32
<codesample lang="ebuild">
33
elog "They are listed in /usr/share/doc/${PF}/INSTALL.gz"
34
</codesample>
35
36
Do something like:
37
38
<codesample lang="ebuild">
39
elog "They are listed in the INSTALL file in /usr/share/doc/${PF}"
40
</codesample>
41
</body>
42
</section>
43
22
</chapter>
44
</chapter>
23
45
24
</guide>
46
</guide>

Return to bug 169772