some janitorial work -- fixing kernel-doc content

Robert P. J. Day rpjday at crashcourse.ca
Thu Oct 25 09:39:52 EDT 2012


  if some folks want some janitorial work for the fun of it, consider
cleaning up some of the kernel-doc content scattered throughout the
source files.

  if you don't know what that is, you can generate manuals from the
embedded kernel-doc content with variations of:

  $ make htmldocs
  $ make pdfdocs

and so on -- the resulting docs will show up under
Documentation/DocBook/.

  unsurprisingly, the kernel-doc content sometimes lags behind the
code, so feel free to generate the docs, check out the warnings and
submit patches to clean it up.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================



More information about the Kernelnewbies mailing list