From: Miroslav Benes <mbenes@suse.cz>
To: Petr Mladek <pmladek@suse.com>
Cc: David Vernet <void@manifault.com>,
linux-doc@vger.kernel.org, live-patching@vger.kernel.org,
linux-kernel@vger.kernel.org, jpoimboe@redhat.com,
jikos@kernel.org, joe.lawrence@redhat.com, corbet@lwn.net,
yhs@fb.com, songliubraving@fb.com
Subject: Re: [PATCH] Documentation: livepatch: Add kernel-doc link to klp_enable_patch
Date: Tue, 14 Dec 2021 09:54:42 +0100 (CET) [thread overview]
Message-ID: <alpine.LSU.2.21.2112140952100.20187@pobox.suse.cz> (raw)
In-Reply-To: <YbdvcXKtxvrVqN+2@alley>
> 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
prev parent reply other threads:[~2021-12-14 8:54 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
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 message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=alpine.LSU.2.21.2112140952100.20187@pobox.suse.cz \
--to=mbenes@suse.cz \
--cc=corbet@lwn.net \
--cc=jikos@kernel.org \
--cc=joe.lawrence@redhat.com \
--cc=jpoimboe@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=live-patching@vger.kernel.org \
--cc=pmladek@suse.com \
--cc=songliubraving@fb.com \
--cc=void@manifault.com \
--cc=yhs@fb.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox