lkml.org 
[lkml]   [1999]   [Sep]   [25]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [Q]: Linux and real device drivers
From
Date
  David Hinds <dhinds@zen.stanford.edu> writes:

> One suggestion would be to have a set of man pages included in the
> kernel tree. And try to make them sufficiently useful that people
> would want to keep them up to date. In this case, I think adding to
> the kernel tree would be a good thing, because it keeps the
> documentation in the same place as what it is documenting. I'd be
> willing to write man pages for a few things myself. The current
> documentation in the kernel tree is a bit too informal and incomplete.

I'd love this. The other thing that I'd love is some more
documentation on API changes. Moving my filesystem code from 2.2.3 to
2.2.12 was annoying because I had to spend a while searching mailing
list archives to figure out why the VFS and dcache interface changes
happened and whether I'd have to do anything tricky to make my code
work. Sure, I could have spent a lot of time reading everything on
linux-kernel and taking careful notes of everything that might be
relevant, but I'd really rather spend my time actually writing code.

If a change is important enough to require changing an interface in a
release cycle, it's also important enough to document what changed,
why, and how to update old code.


--nat

--
nat lanza --------------------- research programmer, parallel data lab, cmu scs
magus@cs.cmu.edu -------------------------------- http://www.cs.cmu.edu/~magus/
there are no whole truths; all truths are half-truths -- alfred north whitehead
-
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:54    [from the cache]
©2003-2011 Jasper Spaans