Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
docs/devel/qapi-code-gen: Turn FIXME admonitions into comments
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>
  • Loading branch information
Markus Armbruster committed May 9, 2023
1 parent 0c7811a commit a2836b3
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions docs/devel/qapi-code-gen.rst
Expand Up @@ -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.
Expand Down

0 comments on commit a2836b3

Please sign in to comment.