The `klp_enable_patch()` function is the main entrypoint to the livepatch subsystem, and is invoked by a KLP module from the module_init callback when it is ready to be enabled. The livepatch documentation specifies that `klp_enable_patch()` should be invoked from the `module_init()` callback, but does not actually link the user to the function's kerneldoc comment. This simple change therefore adds a kernel-doc directive to link the `klp_enable_patch()` function's kerneldoc comment in the livepatch documentation page. With this, kernel/livepatch/core.c no longer comes up as a file containing an unused doc with `scripts/find-unused-docs.sh kernel/livepatch` Signed-off-by: David Vernet <void@xxxxxxxxxxxxx> --- Documentation/livepatch/livepatch.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Documentation/livepatch/livepatch.rst b/Documentation/livepatch/livepatch.rst index 68e3651e8af9..4fa9e4ebcc3a 100644 --- a/Documentation/livepatch/livepatch.rst +++ b/Documentation/livepatch/livepatch.rst @@ -312,8 +312,15 @@ the patch cannot get enabled. ------------- The livepatch gets enabled by calling klp_enable_patch() from -the module_init() callback. The system will start using the new -implementation of the patched functions at this stage. +the module_init() callback: + +.. kernel-doc:: kernel/livepatch/core.c + :functions: klp_enable_patch + +---- + +The system will start using the new implementation of the patched functions at +this stage. First, the addresses of the patched functions are found according to their names. The special relocations, mentioned in the section "New functions", -- 2.30.2
