From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
jsnow@redhat.com, eblake@redhat.com, mdroth@linux.vnet.ibm.com,
marcandre.lureau@redhat.com
Subject: [PATCH 1/2] docs/devel/qapi-code-gen: Drop a duplicate paragraph
Date: Tue, 26 Oct 2021 13:10:22 +0200 [thread overview]
Message-ID: <20211026111023.76937-2-armbru@redhat.com> (raw)
In-Reply-To: <20211026111023.76937-1-armbru@redhat.com>
Commit 55ec69f8b1 "docs/devel/qapi-code-gen.txt: Update to new rST
backend conventions" accidentally duplicated a paragraph. Drop it.
Cc: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/qapi-code-gen.rst | 6 ------
1 file changed, 6 deletions(-)
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index b2569de486..1f6805a705 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -993,12 +993,6 @@ multiline argument descriptions.
A 'Since: x.y.z' tagged section lists the release that introduced the
definition.
-The text of a section can start on a new line, in
-which case it must not be indented at all. It can also start
-on the same line as the 'Note:', 'Returns:', etc tag. In this
-case if it spans multiple lines then second and subsequent
-lines must be indented to match the first.
-
An 'Example' or 'Examples' section is automatically rendered
entirely as literal fixed-width text. In other sections,
the text is formatted, and rST markup can be used.
--
2.31.1
next prev parent reply other threads:[~2021-10-26 11:12 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-26 11:10 [PATCH 0/2] qapi: Documentation improvements Markus Armbruster
2021-10-26 11:10 ` Markus Armbruster [this message]
2021-10-26 11:12 ` [PATCH 1/2] docs/devel/qapi-code-gen: Drop a duplicate paragraph Philippe Mathieu-Daudé
2021-10-26 16:09 ` John Snow
2021-10-26 11:10 ` [PATCH 2/2] docs/devel/qapi-code-gen: Belatedly document feature documentation Markus Armbruster
2021-10-26 15:04 ` Kevin Wolf
2021-10-26 15:16 ` 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=20211026111023.76937-2-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=jsnow@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=mdroth@linux.vnet.ibm.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).