qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Cc: "Daniel P. Berrangé" <berrange@redhat.com>,
	"Markus Armbruster" <armbru@redhat.com>,
	"Michael Roth" <mdroth@linux.vnet.ibm.com>,
	"Stefan Hajnoczi" <stefanha@redhat.com>,
	"John Snow" <jsnow@redhat.com>
Subject: [PATCH v3 02/12] qapi/machine.json: Escape a literal '*' in doc comment
Date: Tue, 25 Feb 2020 14:04:27 +0000	[thread overview]
Message-ID: <20200225140437.20609-3-peter.maydell@linaro.org> (raw)
In-Reply-To: <20200225140437.20609-1-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.

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 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



  parent reply	other threads:[~2020-02-25 14:17 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-25 14:04 [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
2020-02-25 14:04 ` [PATCH v3 01/12] qapi/qapi-schema.json: Put headers in their own doc-comment blocks Peter Maydell
2020-02-27 13:53   ` Richard Henderson
2020-02-25 14:04 ` Peter Maydell [this message]
2020-02-27 13:56   ` [PATCH v3 02/12] qapi/machine.json: Escape a literal '*' in doc comment Richard Henderson
2020-02-25 14:04 ` [PATCH v3 03/12] tests/qapi/doc-good.json: Clean up markup Peter Maydell
2020-02-27 13:58   ` Richard Henderson
2020-02-25 14:04 ` [PATCH v3 04/12] scripts/qapi: Move doc-comment whitespace stripping to doc.py Peter Maydell
2020-02-27 13:59   ` Richard Henderson
2020-02-25 14:04 ` [PATCH v3 05/12] scripts/qapi/parser.py: improve doc comment indent handling Peter Maydell
2020-02-27 14:13   ` Richard Henderson
2020-02-25 14:04 ` [PATCH v3 06/12] docs/sphinx: Add new qapi-doc Sphinx extension Peter Maydell
2020-02-25 14:04 ` [PATCH v3 07/12] docs/interop: Convert qemu-ga-ref to rST Peter Maydell
2020-02-25 14:04 ` [PATCH v3 08/12] docs/interop: Convert qemu-qmp-ref " Peter Maydell
2020-02-25 14:04 ` [PATCH v3 09/12] qapi: Use rST markup for literal blocks Peter Maydell
2020-02-25 14:04 ` [PATCH v3 10/12] qga/qapi-schema.json: Add some headings Peter Maydell
2020-02-25 14:04 ` [PATCH v3 11/12] scripts/qapi: Remove texinfo generation support Peter Maydell
2020-02-25 14:04 ` [PATCH v3 12/12] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions Peter Maydell
2020-02-26 11:45 ` [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo Markus Armbruster
2020-03-06 17:30 ` Peter Maydell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200225140437.20609-3-peter.maydell@linaro.org \
    --to=peter.maydell@linaro.org \
    --cc=armbru@redhat.com \
    --cc=berrange@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=mdroth@linux.vnet.ibm.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).