starred/qemu-qemu-1
1
0
Fork 0
mirror of https://github.com/qemu/qemu.git synced 2026-02-04 02:24:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

qemu-options.hx: Drop uses of @var

Browse Source 
A few entries in qemu-options.hx use the syntax "my-option=@var{name}"
(or @var{} with no name specified) when documenting an option that takes
an argument. This syntax isn't consistently used, and the documentation
generation has no support for it: it just appears literally in the
HTML output.

Switch these uses to the more common "my-option=<name>". This also
doesn't have any particular support in the documentation generation
and so appears literally in the output, but it is a little less odd
looking to the end-user.

The other common pattern we have is "my-option=name" with no marking
at all that the right hand side of the '=' is not literal text;
using <> seems preferable to me, as it makes it more distinct from
cases where the right hand side is documenting that only certain
values are permitted, as in "my-option=on|off". This patch doesn't
do anything about existing uses of this pattern (except in one case
which was so confused as to use "my-option=@var{}" in the --help
output and "my-option=" in the RST output, where we change both
for consistency), but prefers not to add more of them.

We don't change the uses of @var in the colo-compare documentation,
as that part deserves a slightly more wide-ranging overhaul that
is better in its own commit.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Zhang Chen <zhangckid@gmail.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Message-id: 20260115142629.665319-4-peter.maydell@linaro.org
This commit is contained in:
Peter Maydell
2026-01-15 14:26:28 +00:00
parent eac712a44b
commit b755c5e7ec
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
qemu-options.hx
View File

@@ -36,7 +36,7 @@ DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
" dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n"
" suppress-vmdesc=on|off disables self-describing migration (default=off)\n"
" nvdimm=on|off controls NVDIMM support (default=off)\n"
" memory-encryption=@var{} memory encryption object to use (default=none)\n"
" memory-encryption=<id> memory encryption object to use (default=none)\n"
" hmat=on|off controls ACPI HMAT support (default=off)\n"
" spcr=on|off controls ACPI SPCR support (default=on)\n"
#ifdef CONFIG_POSIX
@@ -100,7 +100,7 @@ SRST
``nvdimm=on|off``
Enables or disables NVDIMM support. The default is off.
``memory-encryption=``
``memory-encryption=<id>``
Memory encryption object to use. The default is none.
``hmat=on|off``
@@ -180,7 +180,7 @@ SRST
-machine cxl-fmw.0.targets.0=cxl.0,cxl-fmw.0.targets.1=cxl.1,cxl-fmw.0.size=128G,cxl-fmw.0.interleave-granularity=512
``sgx-epc.0.memdev=@var{memid},sgx-epc.0.node=@var{numaid}``
``sgx-epc.0.memdev=<memid>,sgx-epc.0.node=<numaid>``
Define an SGX EPC section.
``smp-cache.0.cache=cachename,smp-cache.0.topology=topologylevel``
@@ -4530,7 +4530,7 @@ DEF("compat", HAS_ARG, QEMU_OPTION_compat,
" Policy for handling unstable management interfaces\n",
QEMU_ARCH_ALL)
SRST
``-compat [deprecated-input=@var{input-policy}][,deprecated-output=@var{output-policy}]``
``-compat [deprecated-input=<input-policy>][,deprecated-output=<output-policy>]``
Set policy for handling deprecated management interfaces (experimental):
``deprecated-input=accept`` (default)
@@ -4546,7 +4546,7 @@ SRST
Limitation: covers only syntactic aspects of QMP.
``-compat [unstable-input=@var{input-policy}][,unstable-output=@var{output-policy}]``
``-compat [unstable-input=<input-policy>][,unstable-output=<output-policy>]``
Set policy for handling unstable management interfaces (experimental):
``unstable-input=accept`` (default)