From: Paolo Bonzini <pbonzini@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org
Subject: [PATCH 5/6] docs: add memory API reference
Date: Tue, 29 Oct 2019 17:22:47 +0100 [thread overview]
Message-ID: <20191029162248.13383-6-pbonzini@redhat.com> (raw)
In-Reply-To: <20191029162248.13383-1-pbonzini@redhat.com>
Add kernel-doc directive to parse and include doc comments from
include/exec/memory.h.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
docs/devel/memory.rst | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/devel/memory.rst b/docs/devel/memory.rst
index b6a4c37ea5..5dc8a12682 100644
--- a/docs/devel/memory.rst
+++ b/docs/devel/memory.rst
@@ -361,3 +361,8 @@ callbacks are called:
- .impl.unaligned specifies that the *implementation* supports unaligned
accesses; if false, unaligned accesses will be emulated by two aligned
accesses.
+
+API Reference
+-------------
+
+.. kernel-doc:: include/exec/memory.h
--
2.21.0
next prev parent reply other threads:[~2019-10-29 16:28 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-29 16:22 [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build Paolo Bonzini
2019-10-29 16:22 ` [PATCH 1/6] docs: import Linux kernel-doc script and extension Paolo Bonzini
2019-10-29 16:22 ` [PATCH 2/6] docs: tweak kernel-doc for QEMU coding standards Paolo Bonzini
2019-10-29 16:22 ` [PATCH 3/6] docs: disable sphinx warning about missing cross references Paolo Bonzini
2019-10-29 16:22 ` [PATCH 4/6] memory: adjust API documentation to (modified) kerneldoc format Paolo Bonzini
2019-10-29 16:22 ` Paolo Bonzini [this message]
2019-10-29 16:22 ` [PATCH 6/6] memory: include MemoryListener documentation and some missing function parameters Paolo Bonzini
2019-10-29 18:06 ` [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build no-reply
2019-10-29 18:21 ` Peter Maydell
2019-10-31 23:48 ` Paolo Bonzini
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=20191029162248.13383-6-pbonzini@redhat.com \
--to=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/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).