• David Vernet's avatar
    Documentation: livepatch: Add livepatch API page · e368cd72
    David Vernet authored
    The livepatch subsystem has several exported functions and objects with
    kerneldoc comments. Though the livepatch documentation contains handwritten
    descriptions of all of these exported functions, they are currently not
    pulled into the docs build using the kernel-doc directive.
    
    In order to allow readers of the documentation to see the full kerneldoc
    comments in the generated documentation files, this change adds a new
    Documentation/livepatch/api.rst page which contains kernel-doc directives
    to link the kerneldoc comments directly in the documentation.  With this,
    all of the hand-written descriptions of the APIs now cross-reference the
    kerneldoc comments on the new Livepatching APIs page, and running
    ./scripts/find-unused-docs.sh on kernel/livepatch no longer shows any files
    as missing documentation.
    
    Note that all of the handwritten API descriptions were left alone with the
    exception of Documentation/livepatch/system-state.rst, which was updated to
    allow the cross-referencing to work correctly. The file now follows the
    cross-referencing formatting guidance specified in
    Documentation/doc-guide/kernel-doc.rst. Furthermore, some comments around
    klp_shadow_free_all() were updated to say <_, id> rather than <*, id> to
    match the rest of the file, and to prevent the docs build from emitting an
    "Inline emphasis start-string without end string" error.
    Signed-off-by: default avatarDavid Vernet <void@manifault.com>
    Reviewed-by: default avatarPetr Mladek <pmladek@suse.com>
    Acked-by: default avatarMiroslav Benes <mbenes@suse.cz>
    Signed-off-by: default avatarPetr Mladek <pmladek@suse.com>
    Link: https://lore.kernel.org/r/20211221145743.4098360-1-void@manifault.com
    e368cd72
index.rst 344 Bytes