From: Kevin Wolf <kwolf@redhat.com>
To: Markus Armbruster <armbru@redhat.com>
Cc: qemu-devel@nongnu.org, hreitz@redhat.com, eblake@redhat.com,
qemu-block@nongnu.org, jsnow@redhat.com
Subject: Re: [PATCH] qapi-block-core: Clean up blockdev-snapshot-internal-sync doc
Date: Thu, 18 Jul 2024 20:18:12 +0200 [thread overview]
Message-ID: <ZplcZPzuOCAWOX4x@redhat.com> (raw)
In-Reply-To: <20240718123609.3063055-1-armbru@redhat.com>
Am 18.07.2024 um 14:36 hat Markus Armbruster geschrieben:
> BlockdevSnapshotInternal is the arguments type of command
> blockdev-snapshot-internal-sync. Its doc comment contains this note:
>
> # .. note:: In a transaction, if @name is empty or any snapshot matching
> # @name exists, the operation will fail. Only some image formats
> # support it; for example, qcow2, and rbd.
>
> "In a transaction" is misleading, and "if @name is empty or any
> snapshot matching @name exists, the operation will fail" is redundant
> with the command's Errors documentation. Drop.
>
> The remainder is fine. Move it to the command's doc comment, where it
> is more prominently visible, with a slight rephrasing for clarity.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Thanks, applied to the block branch.
Kevin
prev parent reply other threads:[~2024-07-18 18:20 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-18 12:36 [PATCH] qapi-block-core: Clean up blockdev-snapshot-internal-sync doc Markus Armbruster
2024-07-18 18:18 ` Kevin Wolf [this message]
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=ZplcZPzuOCAWOX4x@redhat.com \
--to=kwolf@redhat.com \
--cc=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=hreitz@redhat.com \
--cc=jsnow@redhat.com \
--cc=qemu-block@nongnu.org \
--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).