lkml.org 
[lkml]   [1998]   [Oct]   [20]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: Documentation for Kernel functions
On Tue, 20 Oct 1998 peter.teoh@db.com wrote:

> Currently there is no reference manual for all the functions implemented
>in the kernel, or the internal structures. Although there exists a few

> I would like to undertake this task....can someone comment on this?

A good idea, especially for people still learning the kernel (like me).

I have an idea, which might help deciding where to start:
1. Get the kernel symbol list (this should be easy enough).
2. Count (by a small program) how many times each symbol is referenced.
3. Sort most referenced symbol first.
4. Start documenting the symbols on the list from top to bottom.

Alternatively, start documenting modules/source files in the kernel tree so
that whole objects become documented quickly rather than functions here and
there would be documented fragmentedly.

--
| Tuukka Toivonen <tuukkat@ee.oulu.fi> [PGP public key
| Homepage: http://www.ee.oulu.fi/~tuukkat/ available]
| Try also finger -l tuukkat@ee.oulu.fi
| Studying information engineering at the University of Oulu
+-----------------------------------------------------------


-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.rutgers.edu
Please read the FAQ at http://www.tux.org/lkml/

\
 
 \ /
  Last update: 2005-03-22 13:45    [from the cache]
©2003-2011 Jasper Spaans