Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 102877 - genkernel.xml - broken code listings
Summary: genkernel.xml - broken code listings
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Xavier Neys (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-08-17 10:38 UTC by Łukasz Damentko (RETIRED)
Modified: 2005-08-18 11:32 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Łukasz Damentko (RETIRED) gentoo-dev 2005-08-17 10:38:48 UTC
I didn't check very careful, but i believe that all the code listings in your
doc aren't ok.

There always should be a prompt to show who - root or user - uses a command, and
also all commands must be inside the <i> tag.

for example:

<pre caption="Creating a compressed tarball containing the kernel modules">
<comment># Create a tar.gz containing all the modules</comment>
cd /
tar -cf /tmp/modules-X.Y.Z.tar.gz /lib/modules/X.Y.Z/
</pre>

should be:

<pre caption="Creating a compressed tarball containing the kernel modules">
<comment>(Create a tar.gz containing all the modules)</comment>
# <i>cd /</i>
# <i>tar -cf /tmp/modules-X.Y.Z.tar.gz /lib/modules/X.Y.Z/</i>
</pre>

More details can be found in http://www.gentoo.org/doc/en/xml-guide.xml
Comment 1 Xavier Neys (RETIRED) gentoo-dev 2005-08-18 03:34:17 UTC
No need to force that on Tim.
/me will fix coding style :)
Comment 2 Xavier Neys (RETIRED) gentoo-dev 2005-08-18 04:34:42 UTC
Coding style fixed.
Comment 3 Tim Yamin (RETIRED) gentoo-dev 2005-08-18 11:32:58 UTC
Thanks Xavier! :)