From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, Eric Blake <eblake@redhat.com>
Subject: [PULL 3/5] qapi: Elide "Potential additional modes" from generated docs
Date: Sat, 3 Feb 2024 09:34:13 +0100 [thread overview]
Message-ID: <20240203083415.2937003-4-armbru@redhat.com> (raw)
In-Reply-To: <20240203083415.2937003-1-armbru@redhat.com>
Documentation of BlockExportRemoveMode has
Potential additional modes to be added in the future:
hide: Just hide export from new clients, leave existing connections
as is. Remove export after all clients are disconnected.
soft: Hide export from new clients, answer with ESHUTDOWN for all
further requests from existing clients.
I think this is useful only for developers. Elide it from generated
documentation by turning it into a TODO section.
This effectively reverts my own commit b71fd73cc45 (Revert "qapi:
BlockExportRemoveMode: move comments to TODO"). At the time, I was
about to elide TODO sections from the generated manual, I wasn't sure
about this one, and decided to avoid change. And now I've made up my
mind.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240129115008.674248-4-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
qapi/block-export.json | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/qapi/block-export.json b/qapi/block-export.json
index 7874a49ba7..e063e9255a 100644
--- a/qapi/block-export.json
+++ b/qapi/block-export.json
@@ -266,13 +266,14 @@
#
# @hard: Drop all connections immediately and remove export.
#
-# Potential additional modes to be added in the future:
+# TODO: Potential additional modes to be added in the future:
#
-# hide: Just hide export from new clients, leave existing connections
-# as is. Remove export after all clients are disconnected.
+# - hide: Just hide export from new clients, leave existing
+# connections as is. Remove export after all clients are
+# disconnected.
#
-# soft: Hide export from new clients, answer with ESHUTDOWN for all
-# further requests from existing clients.
+# - soft: Hide export from new clients, answer with ESHUTDOWN for
+# all further requests from existing clients.
#
# Since: 2.12
##
--
2.43.0
next prev parent reply other threads:[~2024-02-03 8:35 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-03 8:34 [PULL 0/5] QAPI patches patches for 2024-02-03 Markus Armbruster
2024-02-03 8:34 ` [PULL 1/5] qapi: Drop redundant documentation of inherited members Markus Armbruster
2024-02-03 8:34 ` [PULL 2/5] qapi: Drop redundant documentation of conditional Markus Armbruster
2024-02-03 8:34 ` Markus Armbruster [this message]
2024-02-03 8:34 ` [PULL 4/5] qga: Move type description right after type name Markus Armbruster
2024-02-03 8:34 ` [PULL 5/5] qga/qapi-schema: Move command description right after command name Markus Armbruster
2024-02-03 16:27 ` [PULL 0/5] QAPI patches patches for 2024-02-03 Peter Maydell
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=20240203083415.2937003-4-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/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).