Linux Documentation
 help / color / mirror / Atom feed
* [PATCH] Documentation: livepatch: Point klp_callbacks kernel-doc at livepatch_external.h
@ 2026-09-05  8:54 Karl Mehltretter
  2026-09-05 17:08 ` Randy Dunlap
  2026-09-07 15:49 ` Jonathan Corbet
  0 siblings, 2 replies; 3+ messages in thread
From: Karl Mehltretter @ 2026-09-05  8:54 UTC (permalink / raw)
  To: Josh Poimboeuf, Jiri Kosina, Miroslav Benes, Petr Mladek
  Cc: Karl Mehltretter, Jonathan Corbet, Joe Lawrence, live-patching,
	linux-doc, Shuah Khan, Randy Dunlap

api.rst asks include/linux/livepatch.h for struct klp_callbacks.
Commit dd590d4d57eb ("objtool/klp: Introduce klp diff subcommand for
diffing object files") moved the structure and its kernel-doc comment
to include/linux/livepatch_external.h. Since then the Object Types
section renders the other four structures but not klp_callbacks.

Add a directive for the new header.

Fixes: dd590d4d57eb ("objtool/klp: Introduce klp diff subcommand for diffing object files")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 Documentation/livepatch/api.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/livepatch/api.rst b/Documentation/livepatch/api.rst
index 78944b63d74b..2a98c517da9d 100644
--- a/Documentation/livepatch/api.rst
+++ b/Documentation/livepatch/api.rst
@@ -27,4 +27,7 @@ Object Types
 ============
 
 .. kernel-doc:: include/linux/livepatch.h
-   :identifiers: klp_patch klp_object klp_func klp_callbacks klp_state
+   :identifiers: klp_patch klp_object klp_func klp_state
+
+.. kernel-doc:: include/linux/livepatch_external.h
+   :identifiers: klp_callbacks
-- 
2.53.0


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

* Re: [PATCH] Documentation: livepatch: Point klp_callbacks kernel-doc at livepatch_external.h
  2026-09-05  8:54 [PATCH] Documentation: livepatch: Point klp_callbacks kernel-doc at livepatch_external.h Karl Mehltretter
@ 2026-09-05 17:08 ` Randy Dunlap
  2026-09-07 15:49 ` Jonathan Corbet
  1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2026-09-05 17:08 UTC (permalink / raw)
  To: Karl Mehltretter, Josh Poimboeuf, Jiri Kosina, Miroslav Benes,
	Petr Mladek
  Cc: Jonathan Corbet, Joe Lawrence, live-patching, linux-doc,
	Shuah Khan



On 9/5/26 1:54 AM, Karl Mehltretter wrote:
> api.rst asks include/linux/livepatch.h for struct klp_callbacks.
> Commit dd590d4d57eb ("objtool/klp: Introduce klp diff subcommand for
> diffing object files") moved the structure and its kernel-doc comment
> to include/linux/livepatch_external.h. Since then the Object Types
> section renders the other four structures but not klp_callbacks.
> 
> Add a directive for the new header.
> 
> Fixes: dd590d4d57eb ("objtool/klp: Introduce klp diff subcommand for diffing object files")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  Documentation/livepatch/api.rst | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/livepatch/api.rst b/Documentation/livepatch/api.rst
> index 78944b63d74b..2a98c517da9d 100644
> --- a/Documentation/livepatch/api.rst
> +++ b/Documentation/livepatch/api.rst
> @@ -27,4 +27,7 @@ Object Types
>  ============
>  
>  .. kernel-doc:: include/linux/livepatch.h
> -   :identifiers: klp_patch klp_object klp_func klp_callbacks klp_state
> +   :identifiers: klp_patch klp_object klp_func klp_state
> +
> +.. kernel-doc:: include/linux/livepatch_external.h
> +   :identifiers: klp_callbacks

-- 
~Randy

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

* Re: [PATCH] Documentation: livepatch: Point klp_callbacks kernel-doc at livepatch_external.h
  2026-09-05  8:54 [PATCH] Documentation: livepatch: Point klp_callbacks kernel-doc at livepatch_external.h Karl Mehltretter
  2026-09-05 17:08 ` Randy Dunlap
@ 2026-09-07 15:49 ` Jonathan Corbet
  1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2026-09-07 15:49 UTC (permalink / raw)
  To: Karl Mehltretter, Josh Poimboeuf, Jiri Kosina, Miroslav Benes,
	Petr Mladek
  Cc: Karl Mehltretter, Joe Lawrence, live-patching, linux-doc,
	Shuah Khan, Randy Dunlap

Karl Mehltretter <kmehltretter@gmail.com> writes:

> api.rst asks include/linux/livepatch.h for struct klp_callbacks.
> Commit dd590d4d57eb ("objtool/klp: Introduce klp diff subcommand for
> diffing object files") moved the structure and its kernel-doc comment
> to include/linux/livepatch_external.h. Since then the Object Types
> section renders the other four structures but not klp_callbacks.
>
> Add a directive for the new header.
>
> Fixes: dd590d4d57eb ("objtool/klp: Introduce klp diff subcommand for diffing object files")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
> ---
>  Documentation/livepatch/api.rst | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/livepatch/api.rst b/Documentation/livepatch/api.rst
> index 78944b63d74b..2a98c517da9d 100644
> --- a/Documentation/livepatch/api.rst
> +++ b/Documentation/livepatch/api.rst
> @@ -27,4 +27,7 @@ Object Types
>  ============
>  
>  .. kernel-doc:: include/linux/livepatch.h
> -   :identifiers: klp_patch klp_object klp_func klp_callbacks klp_state
> +   :identifiers: klp_patch klp_object klp_func klp_state
> +
> +.. kernel-doc:: include/linux/livepatch_external.h
> +   :identifiers: klp_callbacks

Applied, thanks.

jon

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

end of thread, other threads:[~2026-09-07 15:49 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-09-05  8:54 [PATCH] Documentation: livepatch: Point klp_callbacks kernel-doc at livepatch_external.h Karl Mehltretter
2026-09-05 17:08 ` Randy Dunlap
2026-09-07 15:49 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox