qapi: Elide "Potential additional modes" from generated docs
authorMarkus Armbruster <armbru@redhat.com>
Mon, 29 Jan 2024 11:50:06 +0000 (12:50 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Sat, 3 Feb 2024 08:20:01 +0000 (09:20 +0100)
commite3240ac5800f11d0a00262d76180d9a3227131fb
tree61052cb90b2606908972b801f47ced703dc9484c
parent763db74d2b61e34b0747a353c791d0ad6eb8ad2b
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 <armbru@redhat.com>
Message-ID: <20240129115008.674248-4-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
qapi/block-export.json