Messages in this thread | | | Subject | Re: [Q]: Linux and real device drivers | From | Jes Sorensen <> | Date | 27 Sep 1999 10:26:04 +0200 |
| |
>>>>> "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.
I am not sure I as a code hacker would want to do all the docs, it might be an interesting project for people who care a lot about it, to make this their pet project. I can see the people who write code often being reluctant to actually writing the documentation themselves, but it is generally quite easy to fool them into explaining their code if you ask them ;-)
Jes
- 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/
| |