forked from mirrors/linux
e368cd7288
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: David Vernet <void@manifault.com> Reviewed-by: Petr Mladek <pmladek@suse.com> Acked-by: Miroslav Benes <mbenes@suse.cz> Signed-off-by: Petr Mladek <pmladek@suse.com> Link: https://lore.kernel.org/r/20211221145743.4098360-1-void@manifault.com
30 lines
516 B
ReStructuredText
30 lines
516 B
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
=================
|
|
Livepatching APIs
|
|
=================
|
|
|
|
Livepatch Enablement
|
|
====================
|
|
|
|
.. kernel-doc:: kernel/livepatch/core.c
|
|
:export:
|
|
|
|
|
|
Shadow Variables
|
|
================
|
|
|
|
.. kernel-doc:: kernel/livepatch/shadow.c
|
|
:export:
|
|
|
|
System State Changes
|
|
====================
|
|
|
|
.. kernel-doc:: kernel/livepatch/state.c
|
|
:export:
|
|
|
|
Object Types
|
|
============
|
|
|
|
.. kernel-doc:: include/linux/livepatch.h
|
|
:identifiers: klp_patch klp_object klp_func klp_callbacks klp_state
|