Re: [Qemu-devel] [PATCH for-2.9 12/47] qapi/rocker: Fix up doc comment notes on optional members

[Marc-André Lureau]

Hi

On Mon, Mar 13, 2017 at 10:31 AM Markus Armbruster <address@hidden>
wrote:

> Talking about #optional like this
>
>     # Note: fields are marked #optional to indicate that they may or may
>     # not appear ...
>
> doesn't work so well in generated documentation, because the #optional
> tag is not visible there.  Replace by
>
>     # Note: optional members may or may not appear ...
>
> Signed-off-by: Markus Armbruster <address@hidden>
>

indeed,
Reviewed-by: Marc-André Lureau <address@hidden>


> ---
>  qapi/rocker.json | 18 ++++++++++--------
>  1 file changed, 10 insertions(+), 8 deletions(-)
>
> diff --git a/qapi/rocker.json b/qapi/rocker.json
> index 97e2b83..f374038 100644
> --- a/qapi/rocker.json
> +++ b/qapi/rocker.json
> @@ -1,3 +1,5 @@
> +# -*- Mode: Python -*-
> +
>  ##
>  # = Rocker switch device
>  ##
> @@ -137,8 +139,8 @@
>  #
>  # @ip-dst: #optional IP header destination address
>  #
> -# Note: fields are marked #optional to indicate that they may or may not
> -# appear in the flow key depending if they're relevant to the flow key.
> +# Note: optional members may or may not appear in the flow key
> +# depending if they're relevant to the flow key.
>  #
>  # Since: 2.4
>  ##
> @@ -167,8 +169,8 @@
>  #
>  # @ip-tos: #optional IP header TOS field
>  #
> -# Note: fields are marked #optional to indicate that they may or may not
> -# appear in the flow mask depending if they're relevant to the flow mask.
> +# Note: optional members may or may not appear in the flow mask
> +# depending if they're relevant to the flow mask.
>  #
>  # Since: 2.4
>  ##
> @@ -194,8 +196,8 @@
>  #
>  # @out-pport: #optional physical output port
>  #
> -# Note: fields are marked #optional to indicate that they may or may not
> -# appear in the flow action depending if they're relevant to the flow
> action.
> +# Note: optional members may or may not appear in the flow action
> +# depending if they're relevant to the flow action.
>  #
>  # Since: 2.4
>  ##
> @@ -288,8 +290,8 @@
>  #
>  # @ttl-check: #optional perform TTL check
>  #
> -# Note: fields are marked #optional to indicate that they may or may not
> -# appear in the group depending if they're relevant to the group type.
> +# Note: optional members may or may not appear in the group depending
> +# if they're relevant to the group type.
>  #
>  # Since: 2.4
>  ##
> --
> 2.7.4
>
>
> --
Marc-André Lureau