lkml.org 
[lkml]   [2021]   [Dec]   [14]   [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
> From this POV, I suggest to create Documentation/livepatch/API.rst
> and add there the documentation generated from the sources. I mean
> something like:
>
> Documentation/core-api/kernel-api.rst
>
> that results into
>
> https://www.kernel.org/doc/html/latest/core-api/kernel-api.html
>
>
> The livepatch/API.rst might include documentation from
>
> include/linux/livepatch.h
> kernel/livepatch/code.c
> kernel/livepatch/shadow.c
> kernel/livepatch/state.c
>
>
> But let's wait if there are other opinions from another livepatch
> developers.

Yes, please. Do not include anything generated from the source into our
"hand-written" documentation. Or at least not like the proposed patch. It
breaks it as Petr pointed out. A separate API file sounds better to me.

Regards
Miroslav

\
 
 \ /
  Last update: 2021-12-14 09:55    [W:0.055 / U:24.428 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site