All of lore.kernel.org
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: richard.henderson@linaro.org,
	"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: [PULL 09/17] qapi: Fix bullet list markup in documentation
Date: Fri, 28 Apr 2023 12:28:53 +0200	[thread overview]
Message-ID: <20230428102901.1685375-10-armbru@redhat.com> (raw)
In-Reply-To: <20230428102901.1685375-1-armbru@redhat.com>

Peter Maydell's commit 100cc4fe0f08 explains:

    rST insists on a blank line before and after a bulleted list [...]
    Add some extra blank lines in the doc comments so they're
    acceptable rST input.

It missed one in qapi/trace.json.

Paolo Bonzini later added another instance in qapi/stats.json,
providing further, if unintended, evidence for his quip that rST is
the Perl of ASCII-based markups.

Both are parsed as ordinary paragraph, resulting in garbled output.

John Snow missed the need for a blank line when converting
docs/devel/qapi-code-gen.txt to rST.

Add the blank lines we need to get the bullet lists recognized as
such.

Kevin Wolf and Lukas Straub added two more, but indented.  Sphinx
recognizes them as (indented) bullet lists.  The indentation looks
slightly off.

Insert a blank line and delete the extra indentation.

Fixes: 100cc4fe0f0827f8da1a5c05f9c65e2aaa40e03d (qapi: Add blank lines before bulleted lists)
Fixes: 467ef823d83e (qmp: add filtering of statistics by target vCPU)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20230425064223.820979-10-armbru@redhat.com>
[Fix of docs/devel/qapi-code-gen.rst squashed, commit message adjusted]
---
 docs/devel/qapi-code-gen.rst |  1 +
 qapi/block-export.json       |  7 ++++---
 qapi/stats.json              |  1 +
 qapi/trace.json              |  1 +
 qapi/yank.json               | 21 +++++++++++----------
 5 files changed, 18 insertions(+), 13 deletions(-)

diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index d81aac7a19..ea0592034a 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -934,6 +934,7 @@ Example::
 
  ##
  # Some text foo with **bold** and *emphasis*
+ #
  # 1. with a list
  # 2. like that
  #
diff --git a/qapi/block-export.json b/qapi/block-export.json
index 4627bbc4e6..3be3de357f 100644
--- a/qapi/block-export.json
+++ b/qapi/block-export.json
@@ -275,9 +275,10 @@
 # @deprecated: This command is deprecated. Use @block-export-del instead.
 #
 # Returns: error if
-#            - the server is not running
-#            - export is not found
-#            - mode is 'safe' and there are existing connections
+#
+#          - the server is not running
+#          - export is not found
+#          - mode is 'safe' and there are existing connections
 #
 # Since: 2.12
 ##
diff --git a/qapi/stats.json b/qapi/stats.json
index 1f5d3c59ab..f17495ee65 100644
--- a/qapi/stats.json
+++ b/qapi/stats.json
@@ -107,6 +107,7 @@
 # The arguments to the query-stats command; specifies a target for which to
 # request statistics and optionally the required subset of information for
 # that target:
+#
 # - which vCPUs to request statistics for
 # - which providers to request statistics from
 # - which named values to return within each provider
diff --git a/qapi/trace.json b/qapi/trace.json
index 6c6982a587..f425d10764 100644
--- a/qapi/trace.json
+++ b/qapi/trace.json
@@ -87,6 +87,7 @@
 # @vcpu: The vCPU to act upon (all by default; since 2.7).
 #
 # An event's state is modified if:
+#
 # - its name matches the @name pattern, and
 # - if @vcpu is given, the event has the "vcpu" property.
 #
diff --git a/qapi/yank.json b/qapi/yank.json
index 167a775594..1639744ada 100644
--- a/qapi/yank.json
+++ b/qapi/yank.json
@@ -50,16 +50,17 @@
 # hanging QEMU.
 #
 # Currently implemented yank instances:
-#  - nbd block device:
-#    Yanking it will shut down the connection to the nbd server without
-#    attempting to reconnect.
-#  - socket chardev:
-#    Yanking it will shut down the connected socket.
-#  - migration:
-#    Yanking it will shut down all migration connections. Unlike
-#    @migrate_cancel, it will not notify the migration process, so migration
-#    will go into @failed state, instead of @cancelled state. @yank should be
-#    used to recover from hangs.
+#
+# - nbd block device:
+#   Yanking it will shut down the connection to the nbd server without
+#   attempting to reconnect.
+# - socket chardev:
+#   Yanking it will shut down the connected socket.
+# - migration:
+#   Yanking it will shut down all migration connections. Unlike
+#   @migrate_cancel, it will not notify the migration process, so migration
+#   will go into @failed state, instead of @cancelled state. @yank should be
+#   used to recover from hangs.
 #
 # Since: 6.0
 ##
-- 
2.39.2



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

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-28 10:28 [PULL 00/17] QAPI patches patches for 2023-04-28 Markus Armbruster
2023-04-28 10:28 ` [PULL 01/17] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status Markus Armbruster
2023-04-28 10:28 ` [PULL 02/17] qga/qapi-schema: Fix a misspelled reference Markus Armbruster
2023-04-28 10:28 ` [PULL 03/17] qapi: Fix misspelled references Markus Armbruster
2023-04-28 10:28 ` [PULL 04/17] qapi: Fix up references to long gone error classes Markus Armbruster
2023-04-28 10:28 ` [PULL 05/17] qapi/block-core: Clean up after removal of dirty bitmap @status Markus Armbruster
2023-04-28 10:28 ` [PULL 06/17] qapi: @foo should be used to reference, not ``foo`` Markus Armbruster
2023-04-28 10:28 ` [PULL 07/17] qapi: Tidy up examples Markus Armbruster
2023-04-28 10:28 ` [PULL 08/17] qapi: Delete largely misleading "Stability Considerations" Markus Armbruster
2023-04-28 10:28 ` Markus Armbruster [this message]
2023-04-28 10:28 ` [PULL 10/17] qapi: Fix unintended definition lists in documentation Markus Armbruster
2023-04-28 10:28 ` [PULL 11/17] qga/qapi-schema: Fix member documentation markup Markus Armbruster
2023-04-28 10:28 ` [PULL 12/17] qapi: Fix argument " Markus Armbruster
2023-04-28 10:28 ` [PULL 13/17] qapi: Replace ad hoc "since" documentation by member documentation Markus Armbruster
2023-04-28 10:28 ` [PULL 14/17] qapi: Fix misspelled section tags in doc comments Markus Armbruster
2023-04-28 10:28 ` [PULL 15/17] qapi: Format since information the conventional way: (since X.Y) Markus Armbruster
2023-04-28 10:29 ` [PULL 16/17] qapi storage-daemon/qapi: Fix documentation section structure Markus Armbruster
2023-04-28 10:29 ` [PULL 17/17] docs/devel/qapi-code-gen: Describe some doc markup pitfalls Markus Armbruster
2023-04-29  9:04 ` [PULL 00/17] QAPI patches patches for 2023-04-28 Richard Henderson

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=20230428102901.1685375-10-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=marcandre.lureau@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=richard.henderson@linaro.org \
    --cc=vsementsov@yandex-team.ru \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.