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

qapi: Elide "Potential additional modes" from generated docs

Browse Source 
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 b71fd73cc4 (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>
This commit is contained in:
Markus Armbruster 2024-01-29 12:50:06 +01:00
parent 763db74d2b
commit e3240ac580
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
qapi/block-export.json
View File

@ -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
##