mandocs and mandocs_install

    This is the announcement email I sent to LKML:
    Hey,
    
    this patch adds two new targets to the 2.5 makefiles -- mandocs, and 
    mandocs_install. The targets require two new perl scripts in the scripts/ 
    directory, but in return we get a series of man pages for kernel 
    functions, which are installed in man section 9. This is a good thing, as 
    many programmers expect documentation to be available with man, and 
    hunting through various PS or PDF documents to find the documentation for 
    the function you want can be quite frustrating.
    
    The man pages are just extracted from the various existing DocBook SGML 
    documents, which are generated by kernel-doc. You also need to have 
    docbook2man installed on your machine.
    
    Note that the two scripts (makeman and split-man) need executable 
    permissions, and I couldn't work out how to make this happen in a mere 
    diff. Also please note the formatting is not perfect, but I will tweak 
    other stuff later with further patches -- this is just an initial 
    implementation.
    
    Sample output (HTMLised) can be found at 
    http://www.stillhq.com/linux/mandocs/2.5.70/
    
    Linus, please consider applying.
    
    Thanks,
    Mikal
    
    
    The patch can be found here, and the sample output is here.

posted at: 07:00 | path: /site | permanent link to this entry
There are no comments on this post which have survived moderation. 80 posts have been culled and 130 blocked. Be the first to make a non-spam comment here, please!