[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 01/14] qapi: BlockExportRemoveMode: move comments to TODO
From: |
Markus Armbruster |
Subject: |
Re: [PATCH 01/14] qapi: BlockExportRemoveMode: move comments to TODO |
Date: |
Fri, 25 Mar 2022 13:33:49 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) |
Victor Toso <victortoso@redhat.com> writes:
> @hide and @soft are potential additions which fits the TODO section
> perfectly.
>
> The main motivation is to avoid this whole block of comment entering
> the wrong section in the python parser.
>
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
> qapi/block-export.json | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/qapi/block-export.json b/qapi/block-export.json
> index f183522d0d..1e34927f85 100644
> --- a/qapi/block-export.json
> +++ b/qapi/block-export.json
> @@ -219,13 +219,13 @@
> #
> # @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
> ##
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Doc comments embed user documentation in the source code. The doc
generator extracts it.
TODOs are generally for developers. Should the doc generator suppress
TODO sections?
[PATCH 04/14] qapi: fix example of BLOCK_JOB_PENDING event, Victor Toso, 2022/03/24
[PATCH 09/14] qapi: run-state examples: add missing member, Victor Toso, 2022/03/24
[PATCH 03/14] qapi: fix example of BLOCK_IO_ERROR event, Victor Toso, 2022/03/24