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



    Add a comment to this post:

    Your name:

    Your email: Email me new comments on this post
      (Your email will not be published on this site, and will only be used to contact you directly with a reply to your comment if needed. Oh, and we'll use it to send you new comments on this post it you selected that checkbox.)


    Your website:

    Comments:


    Because of excessive load, this site is generated statically every several hours. Therefore, your comment may take some time to appear here. Unless you get an error message when you click the select button below, then all is normal and the comment will appear in due course. If you want you can checkout all recently approved comments while your waiting.