Re: [Q]: Linux and real device drivers
Wade Hampton (whampton@staffnet.com)
Mon, 27 Sep 1999 09:33:38 -0400
Jes Sorensen wrote:
>
> >>>>> "Jeff" == Jeff Garzik <jgarzik@pobox.com> writes:
>
> Jeff> Jes Sorensen wrote:
> >> I am not saying we cannot improve our documentation, I am merely
> >> pointing out that we are dealing with volunteers and it is
> >> unrealistic to expect them all to do documentation all the time
> >> when hacking is so much more fun.
>
> Jeff> No question about that ;)
>
> Jeff> Any API docs are better than no API docs. Even simply adding
> Jeff> stub API docs is very helpful, because that gives people a
> Jeff> central place to look for a list of public functions they can
> Jeff> use in their drivers and other code.
>
> Actually I have to disagree strongly on this one, bad API docs are
> worth than no docs since it is often misleading. That said, stub API
> docs might be a good idea.
If the stubs are inserted, then others, not just the original coders
can help to fill in the docs. I for one, seem to spend more time
writing docs than code lately, and **might** be able to help! It
would be real fun and a great learning experience -- you would
have to learn what the code does to document it!
--
W. Wade, Hampton <whampton@staffnet.com>
-
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/