[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 20/30] qapi/machine.json: Escape a literal '*' in doc comment
From: |
Peter Maydell |
Subject: |
[PATCH v2 20/30] qapi/machine.json: Escape a literal '*' in doc comment |
Date: |
Thu, 13 Feb 2020 17:56:37 +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 v2 13/30] qapi/block-core.json: Use explicit bulleted lists, (continued)
- [PATCH v2 13/30] qapi/block-core.json: Use explicit bulleted lists, Peter Maydell, 2020/02/13
- [PATCH v2 14/30] qapi/ui.json: Use explicit bulleted lists, Peter Maydell, 2020/02/13
- [PATCH v2 16/30] qapi: Add blank lines before bulleted lists, Peter Maydell, 2020/02/13
- [PATCH v2 18/30] qapi: Delete all the "foo: dropped in n.n" notes, Peter Maydell, 2020/02/13
- [PATCH v2 15/30] qapi/{block, misc, tmp, net}.json: Use explicit bulleted lists, Peter Maydell, 2020/02/13
- [PATCH v2 19/30] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/13
- [PATCH v2 17/30] qapi/migration.json: Replace _this_ with *this*, Peter Maydell, 2020/02/13
- [PATCH v2 22/30] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/13
- [PATCH v2 20/30] qapi/machine.json: Escape a literal '*' in doc comment,
Peter Maydell <=
- [PATCH v2 21/30] tests/qapi/doc-good.json: Clean up markup, Peter Maydell, 2020/02/13
- [PATCH v2 28/30] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/02/13
- [PATCH v2 25/30] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/02/13
- [PATCH v2 09/30] qapi: Fix indent level on doc comments in json files, Peter Maydell, 2020/02/13
- [PATCH v2 24/30] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/02/13
- [PATCH v2 27/30] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/02/13
- [PATCH v2 23/30] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/02/13
- [PATCH v2 26/30] docs/interop: Convert qemu-qmp-ref to rST, Peter Maydell, 2020/02/13