|
|
Subscribe / Log in / New account

Kernel documentation

Kernel documentation

Posted Nov 6, 2015 23:18 UTC (Fri) by mathstuf (subscriber, #69389)
In reply to: Kernel documentation by bronson
Parent article: Kernel documentation

This would be for the documentation, not the main build step (like Perl is (was?)). And the documentation is readable in its source form (unlike raw HTML or docbook).


to post comments

Kernel documentation

Posted Nov 12, 2015 2:58 UTC (Thu) by tbird20d (subscriber, #1901) [Link]

It would be nice to do some kind of "checkdoc" functionality as part of pre-testing patches prior to their acceptance into mainline. Linus mentioned that he'd like to see some documentation moved from Documentation into the source files (or at least some attempt to capture information that is now only available in source comments - besides the structure and function docs. In any event, it would be nice to keep documentation operations lightweight and avoid too many build system dependencies. I'd vote against a dependency on Haskell (although I kind of like pandoc).


Copyright © 2025, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds