LWN.net Logo

Once upon a time (;-))

Once upon a time (;-))

Posted Sep 12, 2007 0:14 UTC (Wed) by davecb (subscriber, #1574)
Parent article: LinuxConf.eu: Documentation and user-space API design

When one wanted to provide a chunk of functionality
to Multics, one wrote a white paper arguing its
desirability. This was Good. Then we wrote
tutorial and manual pages, because we were
writing, ayway.

The Unix folks from Bell labs, who worked on
Multics, decide that, when developing Unix,
writing man pages was Almost As Good. As
were tutorials.

All joking aside, how about a requirement that
one write a white paper, a man page, **and** a
tutorial before you can add a new feature
to the Linux or BSD kernel?

--dave


(Log in to post comments)

Once upon a time (;-))

Posted Sep 13, 2007 18:17 UTC (Thu) by larryr (guest, #4030) [Link]

how about a requirement that one write a white paper, a man page, **and** a tutorial before you can add a new feature

Is it ok if it says

xyz is fully documented in the texinfo documentation. To access the help from your command line, type info xyz

Larry

Copyright © 2008, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds