[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v3 02/12] qapi/machine.json: Escape a literal '*' in doc comment
From: |
Peter Maydell |
Subject: |
[PATCH v3 02/12] qapi/machine.json: Escape a literal '*' in doc comment |
Date: |
Tue, 25 Feb 2020 14:04:27 +0000 |
For rST, '*' is a kind of inline markup (for emphasis), so
"*-softmmu" is a syntax error because of the missing closing '*'.
Escape the '*' with a '\'.
The texinfo document generator will leave the '\' in the
output, which is not ideal, but that generator is going to
go away in a subsequent commit.
Signed-off-by: Peter Maydell <address@hidden>
---
qapi/machine.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 6c11e3cf3a4..58580602524 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -12,7 +12,7 @@
#
# The comprehensive enumeration of QEMU system emulation ("softmmu")
# targets. Run "./configure --help" in the project root directory, and
-# look for the *-softmmu targets near the "--target-list" option. The
+# look for the \*-softmmu targets near the "--target-list" option. The
# individual target constants are not documented here, for the time
# being.
#
--
2.20.1
- [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/02/25
- [PATCH v3 01/12] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/25
- [PATCH v3 02/12] qapi/machine.json: Escape a literal '*' in doc comment,
Peter Maydell <=
- [PATCH v3 03/12] tests/qapi/doc-good.json: Clean up markup, Peter Maydell, 2020/02/25
- [PATCH v3 04/12] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/25
- [PATCH v3 05/12] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/02/25
- [PATCH v3 09/12] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/02/25
- [PATCH v3 06/12] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/02/25
- [PATCH v3 07/12] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/02/25