[v2] qapi qga/qapi-schema: Doc fixes

[PATCH v2 00/16] qapi qga/qapi-schema: Doc fixes

Markus Armbruster posted 16 patches 1 year ago

Diff against v1
Download series mbox

Failed in applying to current master (apply log)

Maintainers: Markus Armbruster <armbru@redhat.com>, Michael Roth <michael.roth@amd.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, "Daniel P. Berrangé" <berrange@redhat.com>, Kashyap Chamarthy <kchamart@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, Eric Blake <eblake@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, "Gonglei (Arei)" <arei.gonglei@huawei.com>, Zhenwei Pi <pizhenwei@bytedance.com>, John Snow <jsnow@redhat.com>, Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, Yanan Wang <wangyanan55@huawei.com>, Juan Quintela <quintela@redhat.com>, Peter Xu <peterx@redhat.com>, Leonardo Bras <leobras@redhat.com>, Jason Wang <jasowang@redhat.com>, Yuval Shaia <yuval.shaia.ml@gmail.com>, Pavel Dovgalyuk <pavel.dovgaluk@ispras.ru>, Stefan Berger <stefanb@linux.vnet.ibm.com>, Stefan Hajnoczi <stefanha@redhat.com>, Gerd Hoffmann <kraxel@redhat.com>, Lukas Straub <lukasstraub2@web.de>, Konstantin Kostiuk <kkostiuk@redhat.com>

docs/devel/qapi-code-gen.rst         |  8 ++-
docs/interop/firmware.json           |  6 +-
qapi/block-core.json                 | 82 ++++++++++++++--------------
qapi/block-export.json               |  7 ++-
qapi/block.json                      |  2 +-
qapi/char.json                       |  4 +-
qapi/control.json                    |  2 +-
qapi/cryptodev.json                  |  4 ++
qapi/job.json                        |  4 +-
qapi/machine-target.json             |  2 +-
qapi/machine.json                    | 30 ++++++----
qapi/migration.json                  | 37 ++++++++-----
qapi/misc.json                       | 13 ++---
qapi/net.json                        | 27 ++++-----
qapi/qapi-schema.json                | 24 +-------
qapi/qdev.json                       |  2 +-
qapi/qom.json                        |  4 +-
qapi/rdma.json                       |  2 +-
qapi/replay.json                     |  3 +
qapi/run-state.json                  | 11 ++--
qapi/stats.json                      |  3 +-
qapi/tpm.json                        |  3 +-
qapi/trace.json                      |  1 +
qapi/ui.json                         | 12 ++--
qapi/yank.json                       | 21 +++----
qga/qapi-schema.json                 | 10 ++--
storage-daemon/qapi/qapi-schema.json | 22 +++++---
27 files changed, 177 insertions(+), 169 deletions(-)

Expand all Fold all

[PATCH v2 00/16] qapi qga/qapi-schema: Doc fixes

Posted by Markus Armbruster 1 year ago

Generated code does not change, except for the last patch, which moves
a bit of code without changing it.

v2:
* PATCH 07: Commit message typo corrected, and extra spaces deleted in
  two more examples
* PATCH 09: Also tidy up two indented bullet lists
* PATCH 10: Three more instances fixed; Fixes: tags
* PATCH 16: Commit message typo corrected [Eric]
* R-bys kept

Markus Armbruster (16):
  qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status
  qga/qapi-schema: Fix a misspelled reference
  qapi: Fix misspelled references
  qapi: Fix up references to long gone error classes
  qapi/block-core: Clean up after removal of dirty bitmap @status
  qapi: @foo should be used to reference, not ``foo``
  qapi: Tidy up examples
  qapi: Delete largely misleading "Stability Considerations"
  qapi: Fix bullet list markup in documentation
  qapi: Fix unintended definition lists in documentation
  qga/qapi-schema: Fix member documentation markup
  qapi: Fix argument documentation markup
  qapi: Replace ad hoc "since" documentation by member documentation
  qapi: Fix misspelled section tags in doc comments
  qapi: Format since information the conventional way: (since X.Y)
  qapi storage-daemon/qapi: Fix documentation section structure

 docs/devel/qapi-code-gen.rst         |  8 ++-
 docs/interop/firmware.json           |  6 +-
 qapi/block-core.json                 | 82 ++++++++++++++--------------
 qapi/block-export.json               |  7 ++-
 qapi/block.json                      |  2 +-
 qapi/char.json                       |  4 +-
 qapi/control.json                    |  2 +-
 qapi/cryptodev.json                  |  4 ++
 qapi/job.json                        |  4 +-
 qapi/machine-target.json             |  2 +-
 qapi/machine.json                    | 30 ++++++----
 qapi/migration.json                  | 37 ++++++++-----
 qapi/misc.json                       | 13 ++---
 qapi/net.json                        | 27 ++++-----
 qapi/qapi-schema.json                | 24 +-------
 qapi/qdev.json                       |  2 +-
 qapi/qom.json                        |  4 +-
 qapi/rdma.json                       |  2 +-
 qapi/replay.json                     |  3 +
 qapi/run-state.json                  | 11 ++--
 qapi/stats.json                      |  3 +-
 qapi/tpm.json                        |  3 +-
 qapi/trace.json                      |  1 +
 qapi/ui.json                         | 12 ++--
 qapi/yank.json                       | 21 +++----
 qga/qapi-schema.json                 | 10 ++--
 storage-daemon/qapi/qapi-schema.json | 22 +++++---
 27 files changed, 177 insertions(+), 169 deletions(-)

-- 
2.39.2