From: Kevin Wolf <kwolf@redhat.com>
To: Markus Armbruster <armbru@redhat.com>
Cc: jsnow@redhat.com, eblake@redhat.com, qemu-devel@nongnu.org,
marcandre.lureau@redhat.com, mdroth@linux.vnet.ibm.com
Subject: Re: [PATCH 2/2] docs/devel/qapi-code-gen: Belatedly document feature documentation
Date: Tue, 26 Oct 2021 17:04:05 +0200 [thread overview]
Message-ID: <YXgY5flIoi1rwUzh@redhat.com> (raw)
In-Reply-To: <20211026111023.76937-3-armbru@redhat.com>
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
next prev parent reply other threads:[~2021-10-26 15:16 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-26 11:10 [PATCH 0/2] qapi: Documentation improvements Markus Armbruster
2021-10-26 11:10 ` [PATCH 1/2] docs/devel/qapi-code-gen: Drop a duplicate paragraph Markus Armbruster
2021-10-26 11:12 ` Philippe Mathieu-Daudé
2021-10-26 16:09 ` John Snow
2021-10-26 11:10 ` [PATCH 2/2] docs/devel/qapi-code-gen: Belatedly document feature documentation Markus Armbruster
2021-10-26 15:04 ` Kevin Wolf [this message]
2021-10-26 15:16 ` Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=YXgY5flIoi1rwUzh@redhat.com \
--to=kwolf@redhat.com \
--cc=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=jsnow@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=mdroth@linux.vnet.ibm.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).