[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 2/8] docs/devel/qapi-code-gen: Fix missing ':' in tagged section d
From: |
Markus Armbruster |
Subject: |
[PULL 2/8] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs |
Date: |
Fri, 26 Jan 2024 07:27:38 +0100 |
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240120095327.666239-2-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@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 0c6f4201bc..76be722f4c 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -989,8 +989,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
- [PULL 0/8] QAPI patches patches for 2024-01-26, Markus Armbruster, 2024/01/26
- [PULL 2/8] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs,
Markus Armbruster <=
- [PULL 1/8] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind', Markus Armbruster, 2024/01/26
- [PULL 3/8] docs: Replace dangling references to docs/interop/qmp-intro.txt, Markus Armbruster, 2024/01/26
- [PULL 8/8] qapi: Fix malformed "Since:" section tags (again), Markus Armbruster, 2024/01/26
- [PULL 5/8] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref, Markus Armbruster, 2024/01/26
- [PULL 4/8] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt, Markus Armbruster, 2024/01/26
- [PULL 7/8] qapi: Indent tagged doc comment sections properly, Markus Armbruster, 2024/01/26
- [PULL 6/8] qapi: Fix mangled "Returns" sections in documentation, Markus Armbruster, 2024/01/26
- Re: [PULL 0/8] QAPI patches patches for 2024-01-26, Peter Maydell, 2024/01/26