[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v6 06/21] qapi/machine.json: Escape a literal '*' in doc comment
From: |
Peter Maydell |
Subject: |
[PATCH v6 06/21] qapi/machine.json: Escape a literal '*' in doc comment |
Date: |
Fri, 25 Sep 2020 17:23:01 +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 0ac1880e4a4..9c45b04363c 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 v6 00/21] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/09/25
- [PATCH v6 01/21] qapi: Fix doc comment indentation again, Peter Maydell, 2020/09/25
- [PATCH v6 03/21] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Peter Maydell, 2020/09/25
- [PATCH v6 04/21] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/09/25
- [PATCH v6 06/21] qapi/machine.json: Escape a literal '*' in doc comment,
Peter Maydell <=
- [PATCH v6 08/21] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/09/25
[PATCH v6 09/21] docs/interop: Convert qemu-qmp-ref to rST, Peter Maydell, 2020/09/25