lkml.org 
[lkml]   [2021]   [Dec]   [10]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] Documentation: livepatch: Add kernel-doc link to klp_enable_patch
Petr Mladek <pmladek@suse.com> wrote on Fri [2021-Dec-10 10:25:05 +0100]:
>
> Honestly, I do not like this. It might be acceptable when it converts
> klp_enable_patch() into a link pointing to another page describing the API.
>
> But this patch causes the entire documentation of klp_enable_patch()
> inserted into livepatch.html. It does not fit there and breaks
> the text flow.

Thank you for taking a look at the patch, Petr.

I'm happy to revise the patch to instead add a new `api.rst` file that
contains the `kernel-doc` directive, which would cause `klp_enable_patch()`
in `livepatch.rst` to automatically link to the separate page as you
suggested.

Just to check though -- I see that `shadow-vars.rst` and `system-state.rst`
have their own "API" sections. Is it preferable to add such a section
directly to `livepatch.rst`, rather than creating a separate file?

Let me know either way and I'll send a v2 patch with your preference.

Kind regards,
David

\
 
 \ /
  Last update: 2021-12-10 19:25    [W:0.917 / U:0.140 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site