From: Petr Mladek <pmladek@suse.com>
To: David Vernet <void@manifault.com>
Cc: live-patching@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-doc@vger.kernel.org, jpoimboe@redhat.com, jikos@kernel.org,
mbenes@suse.cz, joe.lawrence@redhat.com, corbet@lwn.net
Subject: Re: [PATCH v3] Documentation: livepatch: Add livepatch API page
Date: Thu, 23 Dec 2021 12:08:41 +0100 [thread overview]
Message-ID: <YcRYuW78jIU+VxIH@alley> (raw)
In-Reply-To: <20211221145743.4098360-1-void@manifault.com>
On Tue 2021-12-21 06:57:45, David Vernet wrote:
> The livepatch subsystem has several exported functions and objects with
> kerneldoc comments. Though the livepatch documentation contains handwritten
> descriptions of all of these exported functions, they are currently not
> pulled into the docs build using the kernel-doc directive.
>
> In order to allow readers of the documentation to see the full kerneldoc
> comments in the generated documentation files, this change adds a new
> Documentation/livepatch/api.rst page which contains kernel-doc directives
> to link the kerneldoc comments directly in the documentation. With this,
> all of the hand-written descriptions of the APIs now cross-reference the
> kerneldoc comments on the new Livepatching APIs page, and running
> ./scripts/find-unused-docs.sh on kernel/livepatch no longer shows any files
> as missing documentation.
>
> Note that all of the handwritten API descriptions were left alone with the
> exception of Documentation/livepatch/system-state.rst, which was updated to
> allow the cross-referencing to work correctly. The file now follows the
> cross-referencing formatting guidance specified in
> Documentation/doc-guide/kernel-doc.rst. Furthermore, some comments around
> klp_shadow_free_all() were updated to say <_, id> rather than <*, id> to
> match the rest of the file, and to prevent the docs build from emitting an
> "Inline emphasis start-string without end string" error.
>
> Signed-off-by: David Vernet <void@manifault.com>
JFYI, the patch has been committed into livepatch.git, branch
for-5.17/fixes.
Best Regards,
Petr
prev parent reply other threads:[~2021-12-23 11:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-21 14:57 [PATCH v3] Documentation: livepatch: Add livepatch API page David Vernet
2021-12-22 9:37 ` Petr Mladek
2021-12-22 10:53 ` Miroslav Benes
2021-12-23 11:08 ` Petr Mladek [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=YcRYuW78jIU+VxIH@alley \
--to=pmladek@suse.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=void@manifault.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 read-only IMAP folder(s) and NNTP newsgroup(s).