• Jonathan Corbet's avatar
    docs: kernel-doc: Don't mangle literal code blocks in comments · af250290
    Jonathan Corbet authored
    It can be useful to put code snippets into kerneldoc comments; that can be
    done with the "::" operator at the end of a line like this::
    
       if (desperate)
           run_in_circles();
    
    The ".. code-block::" directive can also be used to this end.  kernel-doc
    currently fails to understand these literal blocks and applies its normal
    markup to them, which is then treated as literal by sphinx.  The result is
    unsightly markup instead of a useful code snippet.
    
    Apply a hack to the output code to recognize literal blocks and avoid
    performing any special markup on them.  It's ugly, but that means it fits
    in well with the rest of the script.
    Reviewed-by: default avatarJani Nikula <jani.nikula@intel.com>
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    af250290
kernel-doc 60.5 KB