docs/devel/qapi-code-gen: Turn FIXME admonitions into comments
authorMarkus Armbruster <armbru@redhat.com>
Fri, 28 Apr 2023 10:54:14 +0000 (12:54 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 9 May 2023 06:51:48 +0000 (08:51 +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

index 289869c53bda20e63b5e319cf9ead038f62f7a62..ff7b74bdb27cd3a72ee4295aa4af1ae70bc1f9d0 100644 (file)
@@ -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.