[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 20/29] tests/qapi-schema: Convert doc-good.json to rST-style stron
From: |
Markus Armbruster |
Subject: |
[PULL 20/29] tests/qapi-schema: Convert doc-good.json to rST-style strong/emphasis |
Date: |
Tue, 29 Sep 2020 22:19:17 +0200 |
From: Peter Maydell <peter.maydell@linaro.org>
doc-good.json currently uses the old *strong* and _emphasis_ markup.
As part of the conversion to rST this needs to switch to **strong**
and *emphasis*, because rST uses underscores as part of its markup
of hyperlinks and will otherwise warn about the syntax error.
In commit a660eed482063b we fixed up the in-tree uses of the
old markup:
1) _this_ was replaced with *this*
2) the only in-tree use of *this* was left alone (turning
a 'strong' into an 'emphasis')
(and so currently in-tree nothing is using either new-style
**strong** or old-style _emphasis_).
Update doc-good.json in a similar way:
1) replace _this_ with *this*
2) remove the usage of old-style *this*
(This slightly reduces the coverage for the old Texinfo generator,
which is about to go away, but is fine for the new rST generator
because that does not need to handle strong/emphasis itself because
it is simply passing the entire text as raw rST to Sphinx.)
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-13-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
tests/qapi-schema/doc-good.json | 2 +-
tests/qapi-schema/doc-good.out | 2 +-
tests/qapi-schema/doc-good.texi | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
index c6822145c4..e9af0857db 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -10,7 +10,7 @@
#
# == Subsection
#
-# *strong* _with emphasis_
+# *with emphasis*
# @var {in braces}
#
# * List item one
diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
index b7e3f4313d..419284dae2 100644
--- a/tests/qapi-schema/doc-good.out
+++ b/tests/qapi-schema/doc-good.out
@@ -73,7 +73,7 @@ doc freeform
body=
== Subsection
-*strong* _with emphasis_
+*with emphasis*
@var {in braces}
* List item one
diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi
index 12808989ff..29abef33e9 100644
--- a/tests/qapi-schema/doc-good.texi
+++ b/tests/qapi-schema/doc-good.texi
@@ -4,7 +4,7 @@
@subsection Subsection
-@strong{strong} @emph{with emphasis}
+@strong{with emphasis}
@code{var} @{in braces@}
@itemize @bullet
--
2.26.2
- [PULL 19/29] qga/qapi-schema.json: Add some headings, (continued)
- [PULL 19/29] qga/qapi-schema.json: Add some headings, Markus Armbruster, 2020/09/29
- [PULL 10/29] qapi/block.json: Add newline after "Example:" for block-latency-histogram-set, Markus Armbruster, 2020/09/29
- [PULL 04/29] qapi: Restrict query-vm-generation-id command to machine code, Markus Armbruster, 2020/09/29
- [PULL 07/29] qapi: Extract ACPI commands to 'acpi.json', Markus Armbruster, 2020/09/29
- [PULL 06/29] qapi: Restrict device memory commands to machine code, Markus Armbruster, 2020/09/29
- [PULL 08/29] qapi: Extract PCI commands to 'pci.json', Markus Armbruster, 2020/09/29
- [PULL 11/29] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Markus Armbruster, 2020/09/29
- [PULL 03/29] qapi: Restrict balloon-related commands to machine code, Markus Armbruster, 2020/09/29
- [PULL 09/29] qapi: Fix doc comment indentation again, Markus Armbruster, 2020/09/29
- [PULL 27/29] Remove Texinfo related line from git.orderfile, Markus Armbruster, 2020/09/29
- [PULL 20/29] tests/qapi-schema: Convert doc-good.json to rST-style strong/emphasis,
Markus Armbruster <=
- [PULL 29/29] Remove texinfo dependency from docker and CI configs, Markus Armbruster, 2020/09/29
- [PULL 21/29] meson.build: Move SPHINX_ARGS to top level meson.build file, Markus Armbruster, 2020/09/29
- [PULL 16/29] docs/interop: Convert qemu-ga-ref to rST, Markus Armbruster, 2020/09/29
- [PULL 26/29] scripts/texi2pod: Delete unused script, Markus Armbruster, 2020/09/29
- [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