OpenE2K
/
qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

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>
This commit is contained in:
Markus Armbruster 2023-04-28 12:54:14 +02:00
parent 0c7811aeb9
commit a2836b32b0
1 changed files with 2 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/devel/qapi-code-gen.rst
View 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.