QEMU-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>
Subject: [PULL 14/18] qapi/ui.json: Avoid `...' Texinfo style quoting
Date: Sat, 15 Feb 2020 12:41:29 +0100
Message-ID: <20200215114133.15097-15-armbru@redhat.com> (raw)
In-Reply-To: <20200215114133.15097-1-armbru@redhat.com>

From: Peter Maydell <peter.maydell@linaro.org>

Avoid Texinfo style quoting with `...', because we would like to
switch the doc comments to rST format, and rST treats it as a syntax
error. Use '...' instead, as we do in other doc comments. This looks
OK in Texinfo, and rST formats it as paired-quotation-marks.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200213175647.17628-13-peter.maydell@linaro.org>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/ui.json | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/qapi/ui.json b/qapi/ui.json
index e8b8b708c7..088a8680ef 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -12,16 +12,16 @@
 #
 # Sets the password of a remote display session.
 #
-# @protocol: `vnc' to modify the VNC server password
-#            `spice' to modify the Spice server password
+# @protocol: 'vnc' to modify the VNC server password
+#            'spice' to modify the Spice server password
 #
 # @password: the new password
 #
 # @connected: how to handle existing clients when changing the
-#             password.  If nothing is specified, defaults to `keep'
-#             `fail' to fail the command if clients are connected
-#             `disconnect' to disconnect existing clients
-#             `keep' to maintain existing clients
+#             password.  If nothing is specified, defaults to 'keep'
+#             'fail' to fail the command if clients are connected
+#             'disconnect' to disconnect existing clients
+#             'keep' to maintain existing clients
 #
 # Returns: Nothing on success
 #          If Spice is not enabled, DeviceNotFound
@@ -43,16 +43,16 @@
 #
 # Expire the password of a remote display server.
 #
-# @protocol: the name of the remote display protocol `vnc' or `spice'
+# @protocol: the name of the remote display protocol 'vnc' or 'spice'
 #
 # @time: when to expire the password.
-#        `now' to expire the password immediately
-#        `never' to cancel password expiration
-#        `+INT' where INT is the number of seconds from now (integer)
-#        `INT' where INT is the absolute time in seconds
+#        'now' to expire the password immediately
+#        'never' to cancel password expiration
+#        '+INT' where INT is the number of seconds from now (integer)
+#        'INT' where INT is the absolute time in seconds
 #
 # Returns: Nothing on success
-#          If @protocol is `spice' and Spice is not active, DeviceNotFound
+#          If @protocol is 'spice' and Spice is not active, DeviceNotFound
 #
 # Since: 0.14.0
 #
-- 
2.21.1



  parent reply index

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-15 11:41 [PULL 00/18] QAPI patches for 2020-02-15 Markus Armbruster
2020-02-15 11:41 ` [PULL 01/18] qapi: Expand documentation for LostTickPolicy Markus Armbruster
2020-02-15 11:41 ` [PULL 02/18] configure: Allow user to specify sphinx-build binary Markus Armbruster
2020-02-15 11:41 ` [PULL 03/18] configure: Pick sphinx-build-3 when available Markus Armbruster
2020-02-15 11:41 ` [PULL 04/18] configure: Check that sphinx-build is using Python 3 Markus Armbruster
2020-02-15 11:41 ` [PULL 05/18] Makefile: Fix typo in dependency list for interop manpages Markus Armbruster
2020-02-15 11:41 ` [PULL 06/18] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment Markus Armbruster
2020-02-15 11:41 ` [PULL 07/18] qga/qapi-schema.json: Fix indent level on doc comments Markus Armbruster
2020-02-15 11:41 ` [PULL 08/18] qga/qapi-schema.json: minor format fixups for rST Markus Armbruster
2020-02-15 11:41 ` [PULL 09/18] qapi/block-core.json: Use literal block for ascii art Markus Armbruster
2020-02-15 11:41 ` [PULL 10/18] qapi: Fix incorrect "Not documented" claims in QMP documentation Markus Armbruster
2020-02-15 11:41 ` [PULL 11/18] qapi: Fix indent level on doc comments in json files Markus Armbruster
2020-02-15 11:41 ` [PULL 12/18] qapi: Remove hardcoded tabs Markus Armbruster
2020-02-15 11:41 ` [PULL 13/18] qapi/ui.json: Put input-send-event body text in the right place Markus Armbruster
2020-02-15 11:41 ` Markus Armbruster [this message]
2020-02-15 11:41 ` [PULL 15/18] qapi: Use explicit bulleted lists Markus Armbruster
2020-02-15 11:41 ` [PULL 16/18] qapi: Add blank lines before " Markus Armbruster
2020-02-15 11:41 ` [PULL 17/18] qapi/migration.json: Replace _this_ with *this* Markus Armbruster
2020-02-15 11:41 ` [PULL 18/18] qapi: Delete all the "foo: dropped in n.n" notes Markus Armbruster
2020-02-17  9:57 ` [PULL 00/18] QAPI patches for 2020-02-15 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=20200215114133.15097-15-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /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

QEMU-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/qemu-devel/0 qemu-devel/git/0.git
	git clone --mirror https://lore.kernel.org/qemu-devel/1 qemu-devel/git/1.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 qemu-devel qemu-devel/ https://lore.kernel.org/qemu-devel \
		qemu-devel@nongnu.org
	public-inbox-index qemu-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.nongnu.qemu-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git