qapi: Doc fixes and improvements

[PATCH 00/13] qapi: Doc fixes and improvements

Markus Armbruster posted 13 patches 5 months, 3 weeks ago

Download series mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20250527073916.1243024-1-armbru@redhat.com

Maintainers: "Michael S. Tsirkin" <mst@redhat.com>, Igor Mammedov <imammedo@redhat.com>, Ani Sinha <anisinha@redhat.com>, Eric Blake <eblake@redhat.com>, Markus Armbruster <armbru@redhat.com>, Gerd Hoffmann <kraxel@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>, "Gonglei (Arei)" <arei.gonglei@huawei.com>, Zhenwei Pi <pizhenwei@bytedance.com>, Jonathan Cameron <jonathan.cameron@huawei.com>, Fan Ni <fan.ni@samsung.com>, John Snow <jsnow@redhat.com>, Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Yanan Wang <wangyanan55@huawei.com>, Zhao Liu <zhao1.liu@intel.com>, Peter Xu <peterx@redhat.com>, Fabiano Rosas <farosas@suse.de>, Jason Wang <jasowang@redhat.com>

qapi/acpi.json         |   2 +-
qapi/audio.json        |   8 +-
qapi/block-core.json   | 184 ++++++++++++++++++++---------------------
qapi/block-export.json |   6 +-
qapi/block.json        |   2 +-
qapi/char.json         |   8 +-
qapi/crypto.json       |  21 ++---
qapi/cryptodev.json    |   2 +-
qapi/cxl.json          |   2 +-
qapi/dump.json         |   6 +-
qapi/introspect.json   |   8 +-
qapi/job.json          |  28 +++----
qapi/machine.json      |  14 ++--
qapi/migration.json    | 100 +++++++++++-----------
qapi/misc-target.json  |   2 +-
qapi/misc.json         |   4 +-
qapi/net.json          |  18 ++--
qapi/qom.json          |   2 +-
qapi/run-state.json    |  12 +--
qapi/transaction.json  |   4 +-
qapi/uefi.json         |   2 +-
qapi/ui.json           |   8 +-
22 files changed, 219 insertions(+), 224 deletions(-)

Expand all Fold all

[PATCH 00/13] qapi: Doc fixes and improvements

Posted by Markus Armbruster 5 months, 3 weeks ago

Markus Armbruster (13):
  qapi: Tidy up run-together sentences in doc comments
  qapi: Tidy up whitespace in doc comments
  qapi: Move (since X.Y) to end of description
  qapi: Avoid breaking lines within (since X.Y)
  qapi: Drop a problematic (Since: 2.11) from query-hotpluggable-cpus
  qapi: Correct spelling of QEMU in doc comments
  qapi: Fix capitalization in doc comments
  qapi: Use proper markup instead of CAPS for emphasis in doc comments
  qapi: Spell JSON null correctly in blockdev-reopen documentation
  qapi: Refer to job-FOO instead of deprecated block-job-FOO in docs
  qapi: Mention both job-cancel and block-job-cancel in doc comments
  qapi: Tidy up references to job state CONCLUDED
  qapi: Improve documentation around job state @concluded

 qapi/acpi.json         |   2 +-
 qapi/audio.json        |   8 +-
 qapi/block-core.json   | 184 ++++++++++++++++++++---------------------
 qapi/block-export.json |   6 +-
 qapi/block.json        |   2 +-
 qapi/char.json         |   8 +-
 qapi/crypto.json       |  21 ++---
 qapi/cryptodev.json    |   2 +-
 qapi/cxl.json          |   2 +-
 qapi/dump.json         |   6 +-
 qapi/introspect.json   |   8 +-
 qapi/job.json          |  28 +++----
 qapi/machine.json      |  14 ++--
 qapi/migration.json    | 100 +++++++++++-----------
 qapi/misc-target.json  |   2 +-
 qapi/misc.json         |   4 +-
 qapi/net.json          |  18 ++--
 qapi/qom.json          |   2 +-
 qapi/run-state.json    |  12 +--
 qapi/transaction.json  |   4 +-
 qapi/uefi.json         |   2 +-
 qapi/ui.json           |   8 +-
 22 files changed, 219 insertions(+), 224 deletions(-)

-- 
2.48.1

Re: [PATCH 00/13] qapi: Doc fixes and improvements

Posted by Eric Blake 5 months, 3 weeks ago

On Tue, May 27, 2025 at 09:39:03AM +0200, Markus Armbruster wrote:
> Markus Armbruster (13):
>   qapi: Tidy up run-together sentences in doc comments
>   qapi: Tidy up whitespace in doc comments
>   qapi: Move (since X.Y) to end of description
>   qapi: Avoid breaking lines within (since X.Y)
>   qapi: Drop a problematic (Since: 2.11) from query-hotpluggable-cpus
>   qapi: Correct spelling of QEMU in doc comments
>   qapi: Fix capitalization in doc comments
>   qapi: Use proper markup instead of CAPS for emphasis in doc comments
>   qapi: Spell JSON null correctly in blockdev-reopen documentation
>   qapi: Refer to job-FOO instead of deprecated block-job-FOO in docs
>   qapi: Mention both job-cancel and block-job-cancel in doc comments
>   qapi: Tidy up references to job state CONCLUDED
>   qapi: Improve documentation around job state @concluded

For the series:

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.
Virtualization:  qemu.org | libguestfs.org

Re: [PATCH 00/13] qapi: Doc fixes and improvements

Posted by Markus Armbruster 5 months, 2 weeks ago

Queued.