From: David Vernet <void@manifault.com>
To: Petr Mladek <pmladek@suse.com>
Cc: linux-doc@vger.kernel.org, live-patching@vger.kernel.org,
linux-kernel@vger.kernel.org, jpoimboe@redhat.com,
jikos@kernel.org, mbenes@suse.cz, 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: Fri, 10 Dec 2021 10:24:58 -0800 [thread overview]
Message-ID: <YbObeiWbLxO8MwrD@dev0025.ash9.facebook.com> (raw)
In-Reply-To: <YbMc8YGIoyRU5nwJ@alley>
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
next prev parent reply other threads:[~2021-12-10 18:25 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 [this message]
2021-12-13 16:06 ` Petr Mladek
2021-12-14 8:54 ` Miroslav Benes
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=YbObeiWbLxO8MwrD@dev0025.ash9.facebook.com \
--to=void@manifault.com \
--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=mbenes@suse.cz \
--cc=pmladek@suse.com \
--cc=songliubraving@fb.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;
as well as URLs for NNTP newsgroup(s).