| Message ID | 20230428105429.1687850-3-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Reformat doc comments | expand |
Markus Armbruster <armbru@redhat.com> wrote: > 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> Reviewed-by: Juan Quintela <quintela@redhat.com>
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.
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(-)