All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] Documentation: livepatch: Add kernel-doc link to klp_enable_patch
@ 2021-12-09 16:53 David Vernet
  2021-12-10  9:25 ` Petr Mladek
  0 siblings, 1 reply; 5+ messages in thread
From: David Vernet @ 2021-12-09 16:53 UTC (permalink / raw)
  To: pmladek, linux-doc, live-patching, linux-kernel, jpoimboe, jikos,
	mbenes, joe.lawrence, corbet
  Cc: void, yhs, songliubraving

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@manifault.com>
---
 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


^ permalink raw reply related	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2021-12-14  8:54 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-09 16:53 [PATCH] Documentation: livepatch: Add kernel-doc link to klp_enable_patch David Vernet
2021-12-10  9:25 ` Petr Mladek
2021-12-10 18:24   ` David Vernet
2021-12-13 16:06     ` Petr Mladek
2021-12-14  8:54       ` Miroslav Benes

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.