It's always nice to get doc fixes into the release, but if it's too
late, it's too late.

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

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.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                    | 26 +++++----
 qapi/migration.json                  | 37 ++++++++-----
 qapi/misc.json                       |  6 +-
 qapi/net.json                        | 25 +++------
 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                  |  6 +-
 qapi/stats.json                      |  3 +-
 qapi/tpm.json                        |  3 +-
 qapi/trace.json                      |  1 +
 qapi/ui.json                         | 12 ++--
 qga/qapi-schema.json                 | 10 ++--
 storage-daemon/qapi/qapi-schema.json | 22 +++++---
 25 files changed, 154 insertions(+), 146 deletions(-)

-- 
2.39.2

On 04.04.23 14:58, Markus Armbruster wrote:
> It's always nice to get doc fixes into the release, but if it's too
> late, it's too late.
> 
> Generated code does not change, except for the last patch, which moves
> a bit of code without changing it.


I didn't deeply check the details, but looked through and nothing seems wrong to me. Good cleanup!

all patches:
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>


PS: do you plan some automatic checks in build process to avoid similar style/naming problems in future?

-- 
Best regards,
Vladimir

Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru> writes:

> On 04.04.23 14:58, Markus Armbruster wrote:
>> It's always nice to get doc fixes into the release, but if it's too
>> late, it's too late.
>> Generated code does not change, except for the last patch, which moves
>> a bit of code without changing it.
>
>
> I didn't deeply check the details, but looked through and nothing seems wrong to me. Good cleanup!
>
> all patches:
> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>

Thanks!  (Belatedly)

> PS: do you plan some automatic checks in build process to avoid similar style/naming problems in future?

I'm about to post patches that make it somewhat harder to screw up
indentation (PATCH 10 fixes such screwups).  Harder, not impossible,
because indentation is meaningful in rST.

I believe the best way to catch argument description screwups is making
argument descriptions mandatory.  I hope to find time for that.

Other than that, no promising ideas, I'm afraid.

On Tue, Apr 4, 2023 at 4:02 PM Markus Armbruster <armbru@redhat.com> wrote:
>
> It's always nice to get doc fixes into the release, but if it's too
> late, it's too late.
>
> Generated code does not change, except for the last patch, which moves
> a bit of code without changing it.
>
> 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.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                    | 26 +++++----
>  qapi/migration.json                  | 37 ++++++++-----
>  qapi/misc.json                       |  6 +-
>  qapi/net.json                        | 25 +++------
>  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                  |  6 +-
>  qapi/stats.json                      |  3 +-
>  qapi/tpm.json                        |  3 +-
>  qapi/trace.json                      |  1 +
>  qapi/ui.json                         | 12 ++--
>  qga/qapi-schema.json                 | 10 ++--
>  storage-daemon/qapi/qapi-schema.json | 22 +++++---
>  25 files changed, 154 insertions(+), 146 deletions(-)
>
> --
> 2.39.2
>
>

lgtm,
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>



-- 
Marc-André Lureau