Re: [PATCH 3/5] qapi: Elide "Potential additional modes" from generated docs

[Eric Blake]

On Mon, Jan 29, 2024 at 12:50:06PM +0100, Markus Armbruster wrote:
> 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>
> ---
>  qapi/block-export.json | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.
Virtualization:  qemu.org | libguestfs.org