From: Markus Armbruster Date: Mon, 29 Jan 2024 11:50:06 +0000 (+0100) Subject: qapi: Elide "Potential additional modes" from generated docs X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=e3240ac5800f11d0a00262d76180d9a3227131fb;p=qemu.git qapi: Elide "Potential additional modes" from generated docs 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 Message-ID: <20240129115008.674248-4-armbru@redhat.com> Reviewed-by: Eric Blake --- 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 ##