[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comme
|
From: |
Markus Armbruster |
|
Subject: |
[PULL 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comments |
|
Date: |
Tue, 9 May 2023 09:59:56 +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>
Message-Id: <20230428105429.1687850-3-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@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
- [PULL 00/17] QAPI patches patches for 2023-05-09, Markus Armbruster, 2023/05/09
- [PULL 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comments,
Markus Armbruster <=
- [PULL 04/17] meson: Fix to make QAPI generator output depend on main.py, Markus Armbruster, 2023/05/09
- [PULL 03/17] qapi: Fix crash on stray double quote character, Markus Armbruster, 2023/05/09
- [PULL 01/17] docs/devel/qapi-code-gen: Clean up use of quotes a bit, Markus Armbruster, 2023/05/09
- [PULL 10/17] tests/qapi-schema/doc-good: Improve argument description tests, Markus Armbruster, 2023/05/09
- [PULL 09/17] tests/qapi-schema/doc-good: Improve a comment, Markus Armbruster, 2023/05/09
- [PULL 07/17] qapi: Tidy up a slightly awkward TODO comment, Markus Armbruster, 2023/05/09
- [PULL 08/17] qapi/dump: Indent bulleted lists consistently, Markus Armbruster, 2023/05/09
- [PULL 05/17] Revert "qapi: BlockExportRemoveMode: move comments to TODO", Markus Armbruster, 2023/05/09
- [PULL 13/17] qapi: Relax doc string @name: description indentation rules, Markus Armbruster, 2023/05/09
- [PULL 16/17] qga/qapi-schema: Reformat doc comments to conform to current conventions, Markus Armbruster, 2023/05/09