• Jani Nikula's avatar
    kernel-doc: support printing exported and non-exported symbols · 86ae2e38
    Jani Nikula authored
    Currently we use docproc to figure out which symbols are exported, and
    then docproc calls kernel-doc on specific functions, to get
    documentation on exported functions. According to git blame and docproc
    comments, this is due to historical reasons, as functions and their
    corresponding EXPORT_SYMBOL* may have been in different files. However
    for more than ten years the recommendation in CodingStyle has been to
    place the EXPORT_SYMBOL* immediately after the closing function brace
    line.
    
    Additionally, the kernel-doc comments for functions are generally placed
    above the function definition in the .c files (i.e. where the
    EXPORT_SYMBOL* is) rather than above the declaration in the .h
    files. There are some exceptions to this, but AFAICT none of these are
    included in DocBook documentation using the "!E" docproc directive.
    
    Therefore, assuming the EXPORT_SYMBOL* and kernel-doc are with the
    function definition, kernel-doc can extract the exported vs. not
    information by making two passes on the input file. Add support for that
    via the new -export and -internal parameters.
    Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
    86ae2e38
kernel-doc 82.6 KB