[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v5 05/20] qapi/machine.json: Escape a literal '*' in doc comment
From: |
Peter Maydell |
Subject: |
[PATCH v5 05/20] qapi/machine.json: Escape a literal '*' in doc comment |
Date: |
Mon, 10 Aug 2020 20:50:04 +0100 |
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.
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/machine.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 5aee2bbd169..3f6ea5693d1 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -13,7 +13,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 v5 00/20] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/08/10
- [PATCH v5 01/20] qapi/migration.json: Fix indentation, Peter Maydell, 2020/08/10
- [PATCH v5 02/20] qapi: Fix indentation, again, Peter Maydell, 2020/08/10
- [PATCH v5 03/20] qapi/block-core.json: Fix nbd-server-start docs, Peter Maydell, 2020/08/10
- [PATCH v5 04/20] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/08/10
- [PATCH v5 05/20] qapi/machine.json: Escape a literal '*' in doc comment,
Peter Maydell <=
- [PATCH v5 06/20] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Peter Maydell, 2020/08/10
- [PATCH v5 07/20] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/08/10
- [PATCH v5 08/20] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/08/10
- [PATCH v5 10/20] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/08/10
- [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/08/10
- [PATCH v5 11/20] docs/interop: Convert qemu-qmp-ref to rST, Peter Maydell, 2020/08/10
- [PATCH v5 12/20] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/08/10
- [PATCH v5 13/20] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/08/10
- [PATCH v5 15/20] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Peter Maydell, 2020/08/10