Re: [PATCH 2/2] docs/devel/qapi-code-gen: Belatedly document feature documentation

[Kevin Wolf]

Am 26.10.2021 um 13:10 hat Markus Armbruster geschrieben:
> Commit 6a8c0b5102 "qapi: Add feature flags to struct types" neglected
> to document how to document feature flags.  Make up for that.
> 
> Cc: Kevin Wolf <kwolf@redhat.com>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  docs/devel/qapi-code-gen.rst | 23 +++++++++++++++--------
>  1 file changed, 15 insertions(+), 8 deletions(-)
> 
> diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
> index 1f6805a705..4b79623f51 100644
> --- a/docs/devel/qapi-code-gen.rst
> +++ b/docs/devel/qapi-code-gen.rst
> @@ -949,15 +949,16 @@ definition must have documentation.
>  Definition documentation starts with a line naming the definition,
>  followed by an optional overview, a description of each argument (for
>  commands and events), member (for structs and unions), branch (for
> -alternates), or value (for enums), and finally optional tagged
> -sections.
> +alternates), or value (for enums), a description of each feature (if
> +any), and finally optional tagged sections.
>  
> -Descriptions of arguments can span multiple lines.  The description
> -text can start on the line following the '\@argname:', in which case it
> -must not be indented at all.  It can also start on the same line as
> -the '\@argname:'.  In this case if it spans multiple lines then second
> -and subsequent lines must be indented to line up with the first
> -character of the first line of the description::
> +The description of an argument or feature 'name' starts with
> +'\@name:'.  The description text can start on the line following the
> +'\@argname:', in which case it must not be indented at all.  It can
> +also start on the same line as the '\@argname:'.  In this case if it
> +spans multiple lines then second and subsequent lines must be indented
> +to line up with the first character of the first line of the
> +description::

I'm confused. Are @name and @argname really two different things? What
does each one mean?

Kevin