qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: michael.roth@amd.com, peter.maydell@linaro.org,
	pbonzini@redhat.com, marcandre.lureau@redhat.com,
	berrange@redhat.com, thuth@redhat.com, philmd@linaro.org,
	mst@redhat.com, imammedo@redhat.com, anisinha@redhat.com,
	eblake@redhat.com, kraxel@redhat.com, kwolf@redhat.com,
	hreitz@redhat.com, arei.gonglei@huawei.com,
	pizhenwei@bytedance.com, jsnow@redhat.com,
	vsementsov@yandex-team.ru, eduardo@habkost.net,
	marcel.apfelbaum@gmail.com, wangyanan55@huawei.com,
	quintela@redhat.com, peterx@redhat.com, leobras@redhat.com,
	jasowang@redhat.com, yuval.shaia.ml@gmail.com,
	pavel.dovgaluk@ispras.ru, jiri@resnulli.us,
	stefanb@linux.vnet.ibm.com, stefanha@redhat.com,
	lukasstraub2@web.de, kkostiuk@redhat.com, qemu-block@nongnu.org,
	victortoso@redhat.com
Subject: [PATCH 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comments
Date: Fri, 28 Apr 2023 12:54:14 +0200	[thread overview]
Message-ID: <20230428105429.1687850-3-armbru@redhat.com> (raw)
In-Reply-To: <20230428105429.1687850-1-armbru@redhat.com>

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(-)

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



  parent reply	other threads:[~2023-04-28 10:55 UTC|newest]

Thread overview: 48+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-28 10:54 [PATCH 00/17] qapi: Reformat doc comments Markus Armbruster
2023-04-28 10:54 ` [PATCH 01/17] docs/devel/qapi-code-gen: Clean up use of quotes a bit Markus Armbruster
2023-04-28 11:21   ` Juan Quintela
2023-04-28 10:54 ` Markus Armbruster [this message]
2023-04-28 17:53   ` [PATCH 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comments Juan Quintela
2023-04-28 10:54 ` [PATCH 03/17] qapi: Fix crash on stray double quote character Markus Armbruster
2023-04-28 17:54   ` Juan Quintela
2023-05-09  7:03     ` Markus Armbruster
2023-04-28 10:54 ` [PATCH 04/17] meson: Fix to make QAPI generator output depend on main.py Markus Armbruster
2023-04-28 17:55   ` Juan Quintela
2023-05-09  7:10     ` Markus Armbruster
2023-04-28 10:54 ` [PATCH 05/17] Revert "qapi: BlockExportRemoveMode: move comments to TODO" Markus Armbruster
2023-04-28 17:57   ` Juan Quintela
2023-04-28 10:54 ` [PATCH 06/17] sphinx/qapidoc: Do not emit TODO sections into user manuals Markus Armbruster
2023-04-28 13:30   ` Ani Sinha
2023-04-28 17:58   ` Juan Quintela
2023-04-28 10:54 ` [PATCH 07/17] qapi: Tidy up a slightly awkward TODO comment Markus Armbruster
2023-04-28 13:25   ` Ani Sinha
2023-04-28 18:02   ` Juan Quintela
2023-05-09  7:12     ` Markus Armbruster
2023-04-28 10:54 ` [PATCH 08/17] qapi/dump: Indent bulleted lists consistently Markus Armbruster
2023-04-28 18:03   ` Juan Quintela
2023-04-28 10:54 ` [PATCH 09/17] tests/qapi-schema/doc-good: Improve a comment Markus Armbruster
2023-04-28 18:05   ` Juan Quintela
2023-04-28 10:54 ` [PATCH 10/17] tests/qapi-schema/doc-good: Improve argument description tests Markus Armbruster
2023-04-28 18:08   ` Juan Quintela
2023-05-09  7:25     ` Markus Armbruster
2023-05-09 10:06       ` Juan Quintela
2023-04-28 10:54 ` [PATCH 11/17] qapi: Fix argument description indentation stripping Markus Armbruster
2023-04-28 18:11   ` Juan Quintela
2023-04-28 10:54 ` [PATCH 12/17] qapi: Rewrite parsing of doc comment section symbols and tags Markus Armbruster
2023-04-28 18:30   ` Juan Quintela
2023-05-09  7:27     ` Markus Armbruster
2023-05-10  7:31   ` Markus Armbruster
2023-04-28 10:54 ` [PATCH 13/17] qapi: Relax doc string @name: description indentation rules Markus Armbruster
2023-04-28 18:25   ` Juan Quintela
2023-05-09  7:41     ` Markus Armbruster
2023-05-09  8:50       ` Markus Armbruster
2023-04-28 10:54 ` [PATCH 14/17] qapi: Section parameter @indent is no longer used, drop Markus Armbruster
2023-04-28 18:22   ` Juan Quintela
2023-04-28 10:54 ` [PATCH 15/17] docs/devel/qapi-code-gen: Update doc comment conventions Markus Armbruster
2023-04-28 18:17   ` Juan Quintela
2023-04-28 10:54 ` [PATCH 16/17] qga/qapi-schema: Reformat doc comments to conform to current conventions Markus Armbruster
2023-04-28 18:21   ` Juan Quintela
2023-04-28 10:54 ` [PATCH 17/17] qapi: " Markus Armbruster
2023-04-28 17:51   ` Juan Quintela
2023-04-28 18:33   ` Lukas Straub
2023-04-28 11:02 ` [PATCH 00/17] qapi: Reformat doc comments Markus Armbruster

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230428105429.1687850-3-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=anisinha@redhat.com \
    --cc=arei.gonglei@huawei.com \
    --cc=berrange@redhat.com \
    --cc=eblake@redhat.com \
    --cc=eduardo@habkost.net \
    --cc=hreitz@redhat.com \
    --cc=imammedo@redhat.com \
    --cc=jasowang@redhat.com \
    --cc=jiri@resnulli.us \
    --cc=jsnow@redhat.com \
    --cc=kkostiuk@redhat.com \
    --cc=kraxel@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=leobras@redhat.com \
    --cc=lukasstraub2@web.de \
    --cc=marcandre.lureau@redhat.com \
    --cc=marcel.apfelbaum@gmail.com \
    --cc=michael.roth@amd.com \
    --cc=mst@redhat.com \
    --cc=pavel.dovgaluk@ispras.ru \
    --cc=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=peterx@redhat.com \
    --cc=philmd@linaro.org \
    --cc=pizhenwei@bytedance.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    --cc=quintela@redhat.com \
    --cc=stefanb@linux.vnet.ibm.com \
    --cc=stefanha@redhat.com \
    --cc=thuth@redhat.com \
    --cc=victortoso@redhat.com \
    --cc=vsementsov@yandex-team.ru \
    --cc=wangyanan55@huawei.com \
    --cc=yuval.shaia.ml@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).