[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 1/7] docs/devel/qapi-code-gen: Fix missing ':' in tagged section
|
From: |
Markus Armbruster |
|
Subject: |
[PATCH 1/7] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs |
|
Date: |
Sat, 20 Jan 2024 10:53:21 +0100 |
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
- [PATCH 0/7] qapi qmp: Documentation fixes, Markus Armbruster, 2024/01/20
- [PATCH 2/7] docs: Replace dangling references to docs/interop/qmp-intro.txt, Markus Armbruster, 2024/01/20
- [PATCH 5/7] qapi: Fix mangled "Returns" sections in documentation, Markus Armbruster, 2024/01/20
- [PATCH 3/7] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt, Markus Armbruster, 2024/01/20
- [PATCH 4/7] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref, Markus Armbruster, 2024/01/20
- [PATCH 1/7] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs,
Markus Armbruster <=
- [PATCH 6/7] qapi: Indent tagged doc comment sections properly, Markus Armbruster, 2024/01/20
- [PATCH 7/7] qapi: Fix malformed "Since:" section tags (again), Markus Armbruster, 2024/01/20
- Re: [PATCH 0/7] qapi qmp: Documentation fixes, Eric Blake, 2024/01/25
- Re: [PATCH 0/7] qapi qmp: Documentation fixes, Markus Armbruster, 2024/01/26