[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comm
From: |
Markus Armbruster |
Subject: |
[PATCH 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comments |
Date: |
Fri, 28 Apr 2023 12:54:14 +0200 |
We have two FIXME notes. These FIXMEs are for QAPI developers. They
are not useful for QAPI schema developers. They are marked up as
admonitions, which makes them look important in generated HTML.
Turn them into comments. QAPI developers will still see them (they
read and write the .rst). QAPI schema developers may still see
them (if they read the .rst instead of the generated .html), but "this
is just for QAPI developers" should be more obvious.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/qapi-code-gen.rst | 9 ++-------
1 file changed, 2 insertions(+), 7 deletions(-)
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index 289869c53b..ff7b74bdb2 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -979,14 +979,9 @@ description::
# in the second style.
The number of spaces between the ':' and the text is not significant.
+.. FIXME The parser accepts these things in almost any order.
-.. admonition:: FIXME
-
- The parser accepts these things in almost any order.
-
-.. admonition:: FIXME
-
- union branches should be described, too.
+.. FIXME union branches should be described, too.
Extensions added after the definition was first released carry a
"(since x.y.z)" comment.
--
2.39.2
- [PATCH 00/17] qapi: Reformat doc comments, Markus Armbruster, 2023/04/28
- [PATCH 07/17] qapi: Tidy up a slightly awkward TODO comment, Markus Armbruster, 2023/04/28
- [PATCH 04/17] meson: Fix to make QAPI generator output depend on main.py, Markus Armbruster, 2023/04/28
- [PATCH 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comments,
Markus Armbruster <=
- [PATCH 11/17] qapi: Fix argument description indentation stripping, Markus Armbruster, 2023/04/28
- [PATCH 08/17] qapi/dump: Indent bulleted lists consistently, Markus Armbruster, 2023/04/28
- [PATCH 14/17] qapi: Section parameter @indent is no longer used, drop, Markus Armbruster, 2023/04/28
- [PATCH 13/17] qapi: Relax doc string @name: description indentation rules, Markus Armbruster, 2023/04/28
- [PATCH 10/17] tests/qapi-schema/doc-good: Improve argument description tests, Markus Armbruster, 2023/04/28