[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-commits] [qemu/qemu] 1ccdae: docs/devel/qapi-code-gen: Normalize v
|
From: |
Peter Maydell |
|
Subject: |
[Qemu-commits] [qemu/qemu] 1ccdae: docs/devel/qapi-code-gen: Normalize version refs x... |
|
Date: |
Tue, 13 Feb 2024 05:55:59 -0800 |
Branch: refs/heads/master
Home: https://github.com/qemu/qemu
Commit: 1ccdae0b6ef08ae03dc4d079068c27ce3b885cb5
https://github.com/qemu/qemu/commit/1ccdae0b6ef08ae03dc4d079068c27ce3b885cb5
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M docs/devel/qapi-code-gen.rst
Log Message:
-----------
docs/devel/qapi-code-gen: Normalize version refs x.y.0 to just x.y
Missed in commit 9bc6e893b72 (qapi: Normalize version references x.y.0
to just x.y).
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-2-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: 399c8cd3ba9215f8e4ea166dce0f6619071a4f66
https://github.com/qemu/qemu/commit/399c8cd3ba9215f8e4ea166dce0f6619071a4f66
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M docs/devel/qapi-code-gen.rst
Log Message:
-----------
docs/devel/qapi-code-gen: Tweak doc comment whitespace
Missed in commit a937b6aa739 (qapi: Reformat doc comments to conform
to current conventions).
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-3-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: d9884878820366e66d3e28436daf5aa3d0fb9c37
https://github.com/qemu/qemu/commit/d9884878820366e66d3e28436daf5aa3d0fb9c37
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qapi/block-core.json
Log Message:
-----------
qapi/block-core: Fix BlockLatencyHistogramInfo doc markup
The description of @bins ends with a literal block:
# @bins: list of io request counts corresponding to histogram
# intervals, one more element than @boundaries has. For the
# example above, @bins may be something like [3, 1, 5, 2], and
# corresponding histogram looks like:
#
# ::
#
# 5| *
Except it actually ends *before* the block: the unindented '::' line
starts a new section. Makes no sense.
We could fix this by indenting the '::' line. Instead, double the
colon at the end of the preceding paragraph, and drop the '::' line.
This shifts the box for the literal block right in generated
documentation, so it lines up with the description.
Fixes: commit a0fcff383b34 (qapi: Use rST markup for literal blocks)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-4-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: 1ed1d4d60885059cee10a411653c5868a0c13097
https://github.com/qemu/qemu/commit/1ed1d4d60885059cee10a411653c5868a0c13097
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qapi/migration.json
M qapi/misc.json
M qapi/qdev.json
M tests/qapi-schema/doc-good.json
M tests/qapi-schema/doc-good.out
Log Message:
-----------
qapi: Indent tagged doc comment sections properly
docs/devel/qapi-code-gen demands that the "second and subsequent lines
of sections other than "Example"/"Examples" should be indented".
Commit a937b6aa739q (qapi: Reformat doc comments to conform to current
conventions) missed a few instances, and messed up a few others.
Clean that up.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-5-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: fd62bff901b6c25df4971066b74049548caadc83
https://github.com/qemu/qemu/commit/fd62bff901b6c25df4971066b74049548caadc83
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M docs/sphinx/qapidoc.py
Log Message:
-----------
sphinx/qapidoc: Drop code to generate doc for simple union tag
QAPISchemaGenRSTVisitor._nodes_for_members() has a special case to
auto-generate documentation for a union tag member of implicit (enum)
type that lacks documentation.
This was useful for simple unions, where the tag member's type was
implicitly. The only implicit enum type left today is 'QType'. Not
worth a special case. Drop. No change to generated documentation.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-6-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: 0cec50119f803723f608f6498975799ab35abf52
https://github.com/qemu/qemu/commit/0cec50119f803723f608f6498975799ab35abf52
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M docs/devel/qapi-code-gen.rst
M qapi/pragma.json
M qga/qapi-schema.json
M scripts/qapi/parser.py
M scripts/qapi/source.py
M tests/qapi-schema/doc-bad-alternate-member.json
M tests/qapi-schema/doc-good.json
Log Message:
-----------
qapi: Require member documentation (with loophole)
The QAPI generator forces you to document your stuff. Except for
command arguments, event data, and members of enum and object types:
these the generator silently "documents" as "Not documented".
We can't require proper documentation there without first fixing all
the offenders. We've always had too many offenders to pull that off.
Right now, we have more than 500. Worse, we seem to fix old ones no
faster than we add new ones: in the past year, we fixed 22 ones, but
added 26 new ones.
To help arrest the backsliding, make missing documentation an error
unless the command, type, or event is in listed in new pragma
documentation-exceptions.
List all the current offenders: 117 commands and types in qapi/, and 9
in qga/.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-7-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: ab27bb03d3cfba492c842fbeca45a4a1f0d20833
https://github.com/qemu/qemu/commit/ab27bb03d3cfba492c842fbeca45a4a1f0d20833
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qga/qapi-schema.json
Log Message:
-----------
qga/qapi-schema: Clean up documentation of guest-set-memory-blocks
The command's doc comment describes the argument, but it's not marked
up as such. Easy enough to fix.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-8-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: 0b34cf84e65c4804eeb6f6b724acbaaa07c8df0b
https://github.com/qemu/qemu/commit/0b34cf84e65c4804eeb6f6b724acbaaa07c8df0b
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qga/qapi-schema.json
Log Message:
-----------
qga/qapi-schema: Clean up documentation of guest-set-vcpus
The command's doc comment describes the argument, but it's not marked
up as such. Easy enough to fix.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-9-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: ca86608f7b0363e6337374bd3f6d47da4f3125d7
https://github.com/qemu/qemu/commit/ca86608f7b0363e6337374bd3f6d47da4f3125d7
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qga/qapi-schema.json
Log Message:
-----------
qga/qapi-schema: Plug trivial documentation holes
Add missing return member documentation of guest-get-disks,
guest-get-devices, guest-get-diskstats, and guest-get-cpustats.
The NVMe SMART information returned by guest-getdisks remains
undocumented. Add a TODO there.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-10-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: e701cd77ab7154982323d5f1c5d3dc56e37c081b
https://github.com/qemu/qemu/commit/e701cd77ab7154982323d5f1c5d3dc56e37c081b
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qapi/pragma.json
M qapi/yank.json
Log Message:
-----------
qapi/yank: Clean up documentaion of yank
The command's doc comment describes the argument, but it's not marked
up as such. Easy enough to fix.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-11-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: a57790f7d72e4672b8f27e7affc036977f666f7e
https://github.com/qemu/qemu/commit/a57790f7d72e4672b8f27e7affc036977f666f7e
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qapi/dump.json
M qapi/pragma.json
Log Message:
-----------
qapi/dump: Clean up documentation of DumpGuestMemoryCapability
The type's doc comment describes its member, but it's not marked up as
such. Easy enough to fix.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-12-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: 2fecccbc841b7225be44f759a22ff245d274bb65
https://github.com/qemu/qemu/commit/2fecccbc841b7225be44f759a22ff245d274bb65
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qapi/block-core.json
M qapi/char.json
M qapi/machine.json
M qapi/pragma.json
M qapi/sockets.json
M qapi/tpm.json
M qapi/ui.json
Log Message:
-----------
qapi: Plug trivial documentation holes around former simple unions
The conversion of simple to flat unions left the @data members
undocumented. Add documentation where it's trivial. Copy verbatim
from the wrapped type's description where possible.
Leftovers: String (to be taken care of in the next commit), and
TransActionAction (left for another day).
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-13-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: 4edb196e209e21c4bc5e10f5873fded1d4565f94
https://github.com/qemu/qemu/commit/4edb196e209e21c4bc5e10f5873fded1d4565f94
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M chardev/char-socket.c
M include/hw/virtio/vhost-vsock-common.h
M qapi/sockets.json
M util/qemu-sockets.c
Log Message:
-----------
qapi: Improve documentation of file descriptor socket addresses
SocketAddress branch @fd is documented in enum SocketAddressType,
unlike the other branches. That's because the branch's type is String
from common.json.
Use a local copy of String, so we can put the documentation in the
usual place.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-14-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: 8bf69544b5e8142a4b7397bc1235eb2c42d1b29d
https://github.com/qemu/qemu/commit/8bf69544b5e8142a4b7397bc1235eb2c42d1b29d
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M include/net/filter.h
M qapi/common.json
M qapi/net.json
Log Message:
-----------
qapi: Move @String out of common.json to discourage reuse
Use of String is problematic, because it results in awkward interface
documentation. The previous commit cleaned up one instance.
Move String out of common.json next to its remaining users in net.json
to discourage reuse elsewhere.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-15-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: 89a2273b9d9e46e2e314fe05faf1b11bf4b3f6d2
https://github.com/qemu/qemu/commit/89a2273b9d9e46e2e314fe05faf1b11bf4b3f6d2
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qapi/block-core.json
M qapi/block-export.json
M qapi/char.json
M qapi/crypto.json
M qapi/machine.json
M qapi/migration.json
M qapi/pragma.json
M qapi/sockets.json
M qapi/stats.json
M qapi/transaction.json
M qapi/ui.json
M qapi/yank.json
Log Message:
-----------
qapi: Add missing union tag documentation
Low-hanging fruit, and except for StatsFilter, the only members of
these unions lacking documentation.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-16-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Commit: 66fcb9d651d69f9f01025acd7ecac35e727c928a
https://github.com/qemu/qemu/commit/66fcb9d651d69f9f01025acd7ecac35e727c928a
Author: Peter Xu <peterx@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M qapi/migration.json
M qapi/pragma.json
Log Message:
-----------
qapi/migration: Add missing tls-authz documentation
As reported in Markus's recent enforcement series on qapi doc [1], we
accidentally miss one entry for tls-authz. Add it.
[1] https://lore.kernel.org/r/20240205074709.3613229-1-armbru@redhat.com
Cc: Daniel P. Berrangé <berrange@redhat.com>
Cc: Fabiano Rosas <farosas@suse.de>
Reported-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Xu <peterx@redhat.com>
Message-ID: <20240207032836.268183-1-peterx@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Update of qapi/pragma.json squashed in, commit message adjusted]
Commit: 66ba157a96ea5a292c8ee326ba3e566dd9b2354d
https://github.com/qemu/qemu/commit/66ba157a96ea5a292c8ee326ba3e566dd9b2354d
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M MAINTAINERS
Log Message:
-----------
MAINTAINERS: Cover qapi/cxl.json
Commit 415442a1b4a (hw/mem/cxl_type3: Add CXL RAS Error Injection
Support.) created qapi/cxl.json without adding it to MAINTAINERS. Fix
that.
Cc: Ben Widawsky <ben.widawsky@intel.com>
Cc: Jonathan Cameron <jonathan.cameron@huawei.com>
Cc: Fan Ni <fan.ni@samsung.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205084747.3623569-2-armbru@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Commit: 0afbba6c3255dbe954ef609987b610cdaaf48f24
https://github.com/qemu/qemu/commit/0afbba6c3255dbe954ef609987b610cdaaf48f24
Author: Markus Armbruster <armbru@redhat.com>
Date: 2024-02-12 (Mon, 12 Feb 2024)
Changed paths:
M MAINTAINERS
Log Message:
-----------
MAINTAINERS: Cover qapi/stats.json
Commit aa09b3d5f8e (stats: Move QMP commands from monitor/ to stats/)
created section Stats, but neglected to add qapi/stats.json to it.
Fix that.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205084747.3623569-3-armbru@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Commit: 61e7a0d27c1336bade78c08e898801e8e93e0bde
https://github.com/qemu/qemu/commit/61e7a0d27c1336bade78c08e898801e8e93e0bde
Author: Peter Maydell <peter.maydell@linaro.org>
Date: 2024-02-13 (Tue, 13 Feb 2024)
Changed paths:
M MAINTAINERS
M chardev/char-socket.c
M docs/devel/qapi-code-gen.rst
M docs/sphinx/qapidoc.py
M include/hw/virtio/vhost-vsock-common.h
M include/net/filter.h
M qapi/block-core.json
M qapi/block-export.json
M qapi/char.json
M qapi/common.json
M qapi/crypto.json
M qapi/dump.json
M qapi/machine.json
M qapi/migration.json
M qapi/misc.json
M qapi/net.json
M qapi/pragma.json
M qapi/qdev.json
M qapi/sockets.json
M qapi/stats.json
M qapi/tpm.json
M qapi/transaction.json
M qapi/ui.json
M qapi/yank.json
M qga/qapi-schema.json
M scripts/qapi/parser.py
M scripts/qapi/source.py
M tests/qapi-schema/doc-bad-alternate-member.json
M tests/qapi-schema/doc-good.json
M tests/qapi-schema/doc-good.out
M util/qemu-sockets.c
Log Message:
-----------
Merge tag 'pull-qapi-2024-02-12' of https://repo.or.cz/qemu/armbru into
staging
QAPI patches patches for 2024-02-12
# -----BEGIN PGP SIGNATURE-----
#
# iQJGBAABCAAwFiEENUvIs9frKmtoZ05fOHC0AOuRhlMFAmXJ4PsSHGFybWJydUBy
# ZWRoYXQuY29tAAoJEDhwtADrkYZTDwsP/iEdmZmjoxMedTzec+GGl5QxfMkqLn14
# eX2jXtzLGZMjGMh4lvMaAdn0AJ3VnBOqxly14sMK6TMWGZkNKJpKF+2Cj8IKte1o
# MlpS1N/7rZxew+B9HkulhS+6UFB3Jndsflm2ot4g+rRjohJCw0v0GapEqjQg6CKp
# efJhiPuBSImm2MSx+n4dj8gkcFOMrgo6oc2ZpN0ypvGb4mupPpnNj6v12yZL8FUM
# Enwsk+pBLQWoYxI9MFDGc0gW9ZBlEdP/nVq/PbglD06Urc241AHGYqT7XLT0oHLl
# 6NA4v3N4GPdSe6oJdOHDFVR+/uPKiiyrseTdYTSGgAN8gcRtHam4WWhqSDIN3Afl
# y41A9ZKkW51TpdszQ6wCdrgbTH5z6K5vnwWfVTwIgdI0mrDcAGWnc2Yr7m6c3fS8
# /Vz00J7OC0P1nXh0IeRxXExXSmaGUUgS3T/KBXPYr0PQPe7Qd+1eTQN6LaliEMRH
# dRpXQabjLmztMhc5VXCv8ihwa7mNVaEn++uRrdKoWOvIQEp0ZeZfxCzp+/2mGPJ0
# YKJc7Ja260h2Y00/Zu2XiwjdzgG+h+QuJO/3OFsZIV5ftFqSBRMCHiGEfANHidld
# Cpo0efeWWTPdV8BQOirGGr0qtDTmgFMFCZTJMsI/g0m9sMCv0WbTtmWNThwaI3uD
# MKnEGG+KX7vD
# =nhrQ
# -----END PGP SIGNATURE-----
# gpg: Signature made Mon 12 Feb 2024 09:12:27 GMT
# gpg: using RSA key 354BC8B3D7EB2A6B68674E5F3870B400EB918653
# gpg: issuer "armbru@redhat.com"
# gpg: Good signature from "Markus Armbruster <armbru@redhat.com>" [full]
# gpg: aka "Markus Armbruster <armbru@pond.sub.org>" [full]
# Primary key fingerprint: 354B C8B3 D7EB 2A6B 6867 4E5F 3870 B400 EB91 8653
* tag 'pull-qapi-2024-02-12' of https://repo.or.cz/qemu/armbru:
MAINTAINERS: Cover qapi/stats.json
MAINTAINERS: Cover qapi/cxl.json
qapi/migration: Add missing tls-authz documentation
qapi: Add missing union tag documentation
qapi: Move @String out of common.json to discourage reuse
qapi: Improve documentation of file descriptor socket addresses
qapi: Plug trivial documentation holes around former simple unions
qapi/dump: Clean up documentation of DumpGuestMemoryCapability
qapi/yank: Clean up documentaion of yank
qga/qapi-schema: Plug trivial documentation holes
qga/qapi-schema: Clean up documentation of guest-set-vcpus
qga/qapi-schema: Clean up documentation of guest-set-memory-blocks
qapi: Require member documentation (with loophole)
sphinx/qapidoc: Drop code to generate doc for simple union tag
qapi: Indent tagged doc comment sections properly
qapi/block-core: Fix BlockLatencyHistogramInfo doc markup
docs/devel/qapi-code-gen: Tweak doc comment whitespace
docs/devel/qapi-code-gen: Normalize version refs x.y.0 to just x.y
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Compare: https://github.com/qemu/qemu/compare/5005aed8a7e7...61e7a0d27c13
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Qemu-commits] [qemu/qemu] 1ccdae: docs/devel/qapi-code-gen: Normalize version refs x...,
Peter Maydell <=