Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 233071 - [patch] revision of the docs
Summary: [patch] revision of the docs
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Hosted Projects
Classification: Unclassified
Component: genkernel (show other bugs)
Hardware: All Linux
: High major (vote)
Assignee: Gentoo Genkernel Maintainers
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 245389 347898
  Show dependency tree
 
Reported: 2008-07-26 21:42 UTC by Nelson
Modified: 2010-12-13 09:48 UTC (History)
1 user (show)

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


Attachments
simple man update (genkernel-man-updt.patch,4.38 KB, patch)
2008-07-26 21:43 UTC, Nelson
Details | Diff
includes previous and removes "--help" docs (genkernel-man-updt2.patch,12.00 KB, patch)
2008-07-26 21:43 UTC, Nelson
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Nelson 2008-07-26 21:42:40 UTC
Genkernel has two full documentations sort of speak, both appear to be complete, but in fact complement each other because no one has bothered to sync them. Those are 'man genkernel' and 'genkernel --help'.

For instance only genkernel.8 explains the luks extensions and initrd options, while only 'genkernel --help' defines splash/gensplash and dozens of others.

I updated the man page (now it has everything that was only in '--help') in the first patch.

It's added work to have this duplication of documentation, so in the second one I also removed references to 'genkernel --help'. If agree, just apply this one, if not apply only the other one.
Comment 1 Nelson 2008-07-26 21:43:04 UTC
Created attachment 161445 [details, diff]
simple man update
Comment 2 Nelson 2008-07-26 21:43:44 UTC
Created attachment 161446 [details, diff]
includes previous and removes "--help" docs
Comment 3 Chris Gianelloni 2008-11-03 12:58:12 UTC
We will look into getting this fixed up in 3.4.11's release.
Comment 4 Sebastian Pipping gentoo-dev 2010-11-29 10:39:12 UTC
Comment on attachment 161445 [details, diff]
simple man update

Comments seem to indicate that this patch is obsolete -> Marking as obsolete.
Comment 5 Sebastian Pipping gentoo-dev 2010-12-13 09:48:45 UTC
Nelson, thanks for your work on this bug report.

man page now synced with output of --help in Git.
I refrain from cutting down --help for the moment.

Please do not hesitate to contact us at <genkernel@g.o.> with further patches against the new asciidoc version of the man page (see doc/genkernel.8.txt):

http://git.overlays.gentoo.org/gitweb/?p=proj/genkernel.git;a=summary

If you are familiar with Git, patches from "git format-patch" would be most welcome.