Bug 205988 – sys-kernel/genkernel: Information inconsistency

• Product: Gentoo Hosted Projects
• Status: RESOLVED FIXED

[Description Maxi Combina 2008-01-15 18:48:25 UTC]

After emerging =sys-kernel/genkernel-3.4.9, the message I see says something like:
"... Documentation is available in the genkernel manual page and in http://www.gentoo.org/doc/en/genkernel.xml"

When I go the mentioned URL, there is a warning:
Disclaimer :  This document is not valid and is not maintained anymore.


Reproducible: Always

[Comment 1 Chris Gianelloni (RETIRED) 2008-01-15 18:53:05 UTC]

Well, the best fix for this is to help us patch up the documentation so that it is correct!

[Comment 2 Maxi Combina 2008-01-15 18:55:50 UTC]

I agree.

Is there a link that you recommend where I can learn what files to modify and how to commit the updated modification?

[Comment 3 Nelson 2008-01-15 20:50:09 UTC]

Try the man page, but it's probably incomplete. I would recommend:
1) read the source and update the man page.
2) make the guide easier to maintain: very short text, more general/conceptual and add the man page to it somehow so it has all the features updated automatically.  Put section 4 in a separate doc. ;)

[Comment 4 Chris Gianelloni (RETIRED) 2008-01-24 09:33:40 UTC]

3) genkernel --help

[Comment 5 johnny 2008-03-19 07:33:45 UTC]

Maxi, gentoo maintains it's documents in a format called guidexml.

Here are the docs to the format http://www.gentoo.org/doc/en/xml-guide.xml

[Comment 6 Sebastian Pipping 2010-12-06 14:22:12 UTC]

Maxi, please contact me (or genkernel@g.o.) if you are interested in helping out with the genkernel docs.  Thanks in advance.

[Comment 7 Sebastian Pipping 2011-01-20 17:44:28 UTC]

The genkernel page (genkernel.xml) has seen some updates by now and the disclaimer "This document is not valid and is not maintained anymore." is gone.

Closing.  Please re-open as needed.