[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 14/29] qapi/machine.json: Escape a literal '*' in doc comment
From: |
Markus Armbruster |
Subject: |
[PULL 14/29] qapi/machine.json: Escape a literal '*' in doc comment |
Date: |
Tue, 29 Sep 2020 22:19:11 +0200 |
From: Peter Maydell <peter.maydell@linaro.org>
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>
Message-Id: <20200925162316.21205-7-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/machine.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 2c237563ea..756dacb06f 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.26.2
- [PULL 28/29] configure: Drop texinfo requirement, (continued)
- [PULL 28/29] configure: Drop texinfo requirement, Markus Armbruster, 2020/09/29
- [PULL 23/29] tests/qapi-schema: Add test of the rST QAPI doc-comment output, Markus Armbruster, 2020/09/29
- [PULL 17/29] docs/interop: Convert qemu-qmp-ref to rST, Markus Armbruster, 2020/09/29
- [PULL 24/29] scripts/qapi: Remove texinfo generation support, Markus Armbruster, 2020/09/29
- [PULL 18/29] qapi: Use rST markup for literal blocks, Markus Armbruster, 2020/09/29
- [PULL 13/29] scripts/qapi/parser.py: improve doc comment indent handling, Markus Armbruster, 2020/09/29
- [PULL 15/29] docs/sphinx: Add new qapi-doc Sphinx extension, Markus Armbruster, 2020/09/29
- [PULL 22/29] meson.build: Make manuals depend on source to Sphinx extensions, Markus Armbruster, 2020/09/29
- [PULL 12/29] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Markus Armbruster, 2020/09/29
- [PULL 02/29] qapi: Correct balloon documentation, Markus Armbruster, 2020/09/29
- [PULL 14/29] qapi/machine.json: Escape a literal '*' in doc comment,
Markus Armbruster <=
- [PULL 05/29] qapi: Restrict query-uuid command to machine code, Markus Armbruster, 2020/09/29
- [PULL 25/29] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Markus Armbruster, 2020/09/29
- Re: [PULL 00/29] QAPI patches patches for 2020-09-29, Peter Maydell, 2020/09/30