All of lore.kernel.org
 help / color / mirror / Atom feed
From: Carl Perry <caperry@edolnx.net>
To: linux-kernel@vger.kernel.org
Subject: Kernel Development Documentation?
Date: Thu, 07 Dec 2000 22:41:51 -0600	[thread overview]
Message-ID: <3A3066A5.7E173772@edolnx.net> (raw)

I was reading an article today on Slashdot about how poorly documented the
Windows API was and had this fear that Linux could get the same way.  So, cut to
the point:

Is there a project underway that documents how things like the VM, the Memory
Manger, what a a specific driver needs to do, what it needs to return, how it is
called, what do all those files in arch/whatever do?  Are there bits and pieces
spewed around all over the net?  It would seem to me that someone ( and I will
volunteer ) sould sit down and put together some sort of documentation system
for the Kernel.  Somthing to the effect of a super help for users with all the
technical details for developers.

Obviously it should be kept on the Internet but in such a way that it can be
contributed to by many people ( preferrably the people who have influence with
the code ).  It should also have a team of "editors" and be maintained such that
it is browsable, printable, and publishable.

I personally feel that now would be the time to do this while the current
development tree is being wrapped up for production and there is no major work
on a 2.5 development tree - at least publicly.  Like I said, I voulenteer to
coordinate this effort and find a place to host it.  What are the thoughts of
others?  Good idea, bad idea?  Input is more than welcome.
-- 
	-Carl Perry
	caperry@edolnx.net

"Real programmers don't draw flowcharts.  Flowcharts are, after
all, the illiterate's form of documentation.  Cavemen drew
flowcharts; look how much good it did them."
	-Fortune (The App, not the Magazine)
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
Please read the FAQ at http://www.tux.org/lkml/

             reply	other threads:[~2000-12-08  5:12 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2000-12-08  4:41 Carl Perry [this message]
2000-12-08  4:46 ` Kernel Development Documentation? Jeff V. Merkey
2000-12-08 13:59 ` Alan Cox
2000-12-08 15:17   ` Daniel Phillips
2000-12-08 15:57     ` Jeff Garzik
2000-12-08 16:13     ` Tigran Aivazian

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=3A3066A5.7E173772@edolnx.net \
    --to=caperry@edolnx.net \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.