Skip to content

Commit 94d689d

Browse files
committed
Merge tag 'pull-qapi-2025-03-11' of https://repo.or.cz/qemu/armbru into staging
QAPI patches patches for 2025-03-11 # -----BEGIN PGP SIGNATURE----- # # iQJGBAABCAAwFiEENUvIs9frKmtoZ05fOHC0AOuRhlMFAmfQCnkSHGFybWJydUBy # ZWRoYXQuY29tAAoJEDhwtADrkYZTsJ0P/jcXiyFxjcbXN/3a6+iuPPqlviiWPAKG # db2aHn2divceFEf7hUrwqjiJIPLDxaq6iJy71bjPUDkE8wAEdsf2zD7ryHo+sGcO # rWaSaHmonn0QHvqcvkGGrbmTH+Ezl1RpP8XVGfG2lmHbjPQ3+EYnRwML6jC8dnvR # C7qkyQ+qxmdV2lWb4MalgABKZToZ2aqnI9lr9KzHmN+55i2OxJrhECUKDHcgtG2i # Pqc1GLGmmQ4Wj+4z0PyvKYZS4LP/90eH8bNyeA6TVsPHxgG79pencct7DOHxhc8q # hHQ1TaqcBeWFQ7tndLMNDnHjm9XpAzMuew87xMTo6R450JxiSn+AkioTE0L563hy # SjeXmIQ8COZbHsuSKlFJcV1OS1c/mJbwpkxptyaMLjTt2Lp9geFs39WKWHcs8pCN # EmWSdvoqmP7D4bp1hXAVSPIIvJ7L2NwnM8ONH0KmRD5uMQrjiHsfvyWHAVnT10yu # 8822hjlJp7l3B1QCi19mTlkiztCFScjb3Se8A+jScP5iX0q9C4H4t+tAw2m4UY1V # pvn4xFxV82CvR3uQI0OMTKhp0/eEfvBioA1PEXOegPH5cS/L7YFF59mta1dCnaL7 # 0JRRCsTAnwAAAXoEteGqF1/6tXBdOnroL0OvHXJQVb2HH5c5YTnuxMiQywcP6Jty # wt1vl42jfTj1 # =Gt4B # -----END PGP SIGNATURE----- # gpg: Signature made Tue 11 Mar 2025 18:03:37 HKT # gpg: using RSA key 354BC8B3D7EB2A6B68674E5F3870B400EB918653 # gpg: issuer "[email protected]" # gpg: Good signature from "Markus Armbruster <[email protected]>" [full] # gpg: aka "Markus Armbruster <[email protected]>" [full] # Primary key fingerprint: 354B C8B3 D7EB 2A6B 6867 4E5F 3870 B400 EB91 8653 * tag 'pull-qapi-2025-03-11' of https://repo.or.cz/qemu/armbru: (61 commits) scripts/qapi/backend: Clean up create_backend()'s failure mode MAINTAINERS: Add jsnow as maintainer for Sphinx documentation docs: add qapi-domain syntax documentation docs: enable qapidoc transmogrifier for QEMU QMP Reference docs: disambiguate cross-references qapi/parser: add undocumented stub members to all_sections docs/qapidoc: generate entries for undocumented members docs/qapidoc: Add "the members of" pointers docs/qapidoc: add intermediate output debugger docs/qapidoc: process @foo into ``foo`` docs/qapidoc: implement transmogrify() method docs/qapidoc: add visit_entity() docs/qapidoc: add visit_sections() method docs/qapidoc: add visit_member() method docs/qapidoc: add visit_returns() method docs/qapidoc: prepare to record entity being transmogrified docs/qapidoc: add visit_feature() method docs/qapidoc: add add_field() and generate_field() helper methods docs/qapidoc: add format_type() method docs/qapidoc: add visit_errors() method ... Signed-off-by: Stefan Hajnoczi <[email protected]>
2 parents 92e4cce + 93db9c8 commit 94d689d

File tree

18 files changed

+3003
-481
lines changed

18 files changed

+3003
-481
lines changed

MAINTAINERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4325,6 +4325,7 @@ S: Orphan
43254325
F: po/*.po
43264326

43274327
Sphinx documentation configuration and build machinery
4328+
M: John Snow <[email protected]>
43284329
M: Peter Maydell <[email protected]>
43294330
S: Maintained
43304331
F: docs/conf.py

docs/conf.py

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,14 @@
6060
# Add any Sphinx extension module names here, as strings. They can be
6161
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
6262
# ones.
63-
extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile', 'qapidoc']
63+
extensions = [
64+
'depfile',
65+
'hxtool',
66+
'kerneldoc',
67+
'qapi_domain',
68+
'qapidoc',
69+
'qmp_lexer',
70+
]
6471

6572
if sphinx.version_info[:3] > (4, 0, 0):
6673
tags.add('sphinx4')
@@ -146,6 +153,15 @@
146153
with open(os.path.join(qemu_docdir, 'defs.rst.inc')) as f:
147154
rst_epilog += f.read()
148155

156+
157+
# Normally, the QAPI domain is picky about what field lists you use to
158+
# describe a QAPI entity. If you'd like to use arbitrary additional
159+
# fields in source documentation, add them here.
160+
qapi_allowed_fields = {
161+
"see also",
162+
}
163+
164+
149165
# -- Options for HTML output ----------------------------------------------
150166

151167
# The theme to use for HTML and HTML Help pages. See the documentation for

docs/devel/codebase.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Some of the main QEMU subsystems are:
2323
- `Devices<device-emulation>` & Board models
2424
- `Documentation <documentation-root>`
2525
- `GDB support<GDB usage>`
26-
- `Migration<migration>`
26+
- :ref:`Migration<migration>`
2727
- `Monitor<QEMU monitor>`
2828
- :ref:`QOM (QEMU Object Model)<qom>`
2929
- `System mode<System emulation>`
@@ -112,7 +112,7 @@ yet, so sometimes the source code is all you have.
112112
* `libdecnumber <https://gitlab.com/qemu-project/qemu/-/tree/master/libdecnumber>`_:
113113
Import of gcc library, used to implement decimal number arithmetic.
114114
* `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/migration>`__:
115-
`Migration framework <migration>`.
115+
:ref:`Migration framework <migration>`.
116116
* `monitor <https://gitlab.com/qemu-project/qemu/-/tree/master/monitor>`_:
117117
`Monitor <QEMU monitor>` implementation (HMP & QMP).
118118
* `nbd <https://gitlab.com/qemu-project/qemu/-/tree/master/nbd>`_:
@@ -193,7 +193,7 @@ yet, so sometimes the source code is all you have.
193193
- `lcitool <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/lcitool>`_:
194194
Generate dockerfiles for CI containers.
195195
- `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/migration>`_:
196-
Test scripts and data for `Migration framework <migration>`.
196+
Test scripts and data for :ref:`Migration framework <migration>`.
197197
- `multiboot <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/multiboot>`_:
198198
Test multiboot functionality for x86_64/i386.
199199
- `qapi-schema <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/qapi-schema>`_:

docs/devel/index-build.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ some of the basics if you are adding new files and targets to the build.
1212
kconfig
1313
docs
1414
qapi-code-gen
15+
qapi-domain
1516
control-flow-integrity

0 commit comments

Comments
 (0)