[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v6 12/21] tests/qapi-schema: Convert doc-good.json to rST-sty
From: |
Markus Armbruster |
Subject: |
Re: [PATCH v6 12/21] tests/qapi-schema: Convert doc-good.json to rST-style strong/emphasis |
Date: |
Tue, 29 Sep 2020 10:33:05 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) |
Peter Maydell <peter.maydell@linaro.org> writes:
> 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>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
- [PATCH v6 15/21] tests/qapi-schema: Add test of the rST QAPI doc-comment outputn, (continued)
- [PATCH v6 14/21] meson.build: Make manuals depend on source to Sphinx extensions, Peter Maydell, 2020/09/25
- [PATCH v6 10/21] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/09/25
- [PATCH v6 20/21] configure: Drop texinfo requirement, Peter Maydell, 2020/09/25
- [PATCH v6 12/21] tests/qapi-schema: Convert doc-good.json to rST-style strong/emphasis, Peter Maydell, 2020/09/25
- Re: [PATCH v6 12/21] tests/qapi-schema: Convert doc-good.json to rST-style strong/emphasis,
Markus Armbruster <=
- [PATCH v6 13/21] meson.build: Move SPHINX_ARGS to top level meson.build file, Peter Maydell, 2020/09/25
- [PATCH v6 17/21] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Peter Maydell, 2020/09/25
[PATCH v6 16/21] scripts/qapi: Remove texinfo generation support, Peter Maydell, 2020/09/25
[PATCH v6 18/21] scripts/texi2pod: Delete unused script, Peter Maydell, 2020/09/25