[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 20/29] qapi/machine.json: Escape a literal '*' in doc comment
From: |
Peter Maydell |
Subject: |
[PATCH 20/29] qapi/machine.json: Escape a literal '*' in doc comment |
Date: |
Thu, 6 Feb 2020 17:30:31 +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 51ffa96be98..a83a7b56b14 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
- Re: [PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section, (continued)
- [PATCH 20/29] qapi/machine.json: Escape a literal '*' in doc comment,
Peter Maydell <=
- [PATCH 21/29] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/06
- [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists, Peter Maydell, 2020/02/06
- [PATCH 16/29] qapi/{block, misc, tmp}.json: Use explicit bulleted lists, Peter Maydell, 2020/02/06
- [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/06