From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com
Subject: [PATCH 1/7] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs
Date: Sat, 20 Jan 2024 10:53:21 +0100 [thread overview]
Message-ID: <20240120095327.666239-2-armbru@redhat.com> (raw)
In-Reply-To: <20240120095327.666239-1-armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/qapi-code-gen.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index ea8228518c..899c16adf3 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -990,8 +990,8 @@ this::
# @feature: Description text
A tagged section starts with one of the following words:
-"Note:"/"Notes:", "Since:", "Example"/"Examples", "Returns:", "TODO:".
-The section ends with the start of a new section.
+"Note:"/"Notes:", "Since:", "Example:"/"Examples:", "Returns:",
+"TODO:". The section ends with the start of a new section.
The second and subsequent lines of sections other than
"Example"/"Examples" should be indented like this::
--
2.43.0
next prev parent reply other threads:[~2024-01-20 9:54 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-20 9:53 [PATCH 0/7] qapi qmp: Documentation fixes Markus Armbruster
2024-01-20 9:53 ` Markus Armbruster [this message]
2024-01-20 9:53 ` [PATCH 2/7] docs: Replace dangling references to docs/interop/qmp-intro.txt Markus Armbruster
2024-01-20 9:53 ` [PATCH 3/7] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt Markus Armbruster
2024-01-20 9:53 ` [PATCH 4/7] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref Markus Armbruster
2024-02-01 21:45 ` John Snow
2024-02-01 21:47 ` John Snow
2024-01-20 9:53 ` [PATCH 5/7] qapi: Fix mangled "Returns" sections in documentation Markus Armbruster
2024-01-20 9:53 ` [PATCH 6/7] qapi: Indent tagged doc comment sections properly Markus Armbruster
2024-01-20 9:53 ` [PATCH 7/7] qapi: Fix malformed "Since:" section tags (again) Markus Armbruster
2024-01-20 23:21 ` Philippe Mathieu-Daudé
2024-01-25 19:48 ` [PATCH 0/7] qapi qmp: Documentation fixes Eric Blake
2024-01-26 6:08 ` Markus Armbruster
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=20240120095327.666239-2-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=jsnow@redhat.com \
--cc=michael.roth@amd.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.