[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH for-6.1 00/10] docs: Format literals correctly in rST
From: |
Peter Maydell |
Subject: |
[PATCH for-6.1 00/10] docs: Format literals correctly in rST |
Date: |
Mon, 26 Jul 2021 15:23:28 +0100 |
In rST markup, single backticks `like this` represent "interpreted
text", which can be handled as a bunch of different things if tagged
with a specific "role":
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text
(the most common one for us is "reference to a URL, which gets
hyperlinked", but it can also be "reference to some other section in
the documentation", "reference to a manpage", or many other things).
The default "role" if none is specified is "title_reference",
intended for references to book or article titles, and it renders
into the HTML as <cite>...</cite> (usually comes out as italics).
This patchseries fixes various places in the manual which were using
single backticks when double backticks (for literal text) were
probably intended. It also fixes a handful of other backtick related
errors that I noticed while finding these errors.
I used
git grep '\(^\|[^`]\)`\($\|[^`]\)' docs
to find these mistakes. (That command will also show a lot of
valid uses of single-backtick for URL and other references.)
A handful of files made this mistake pervasively, and I've given
those their own commit each. Changes which aren't just
single-backtick-to-double-backtick also get their own commit.
Otherwise I've rolled up the rest of the fixes into "other
docs/devel" and "other".
Peter Maydell (10):
docs/devel/build-system.rst: Format literals correctly
docs/devel/build-system.rst: Correct typo in example code
docs/devel/ebpf_rss.rst: Format literals correctly
docs/devel/migration.rst: Format literals correctly
docs/devel: Format literals correctly
docs/system/s390x/protvirt.rst: Format literals correctly
docs/system/arm/cpu-features.rst: Format literals correctly
docs: Format literals correctly
docs/about/removed-features: Fix markup error
docs/tools/virtiofsd.rst: Delete stray backtick
docs/about/index.rst | 2 +-
docs/about/removed-features.rst | 2 +-
docs/devel/build-system.rst | 160 ++++++++++-----------
docs/devel/ebpf_rss.rst | 18 +--
docs/devel/migration.rst | 36 ++---
docs/devel/qgraph.rst | 8 +-
docs/devel/tcg-plugins.rst | 14 +-
docs/devel/testing.rst | 8 +-
docs/interop/live-block-operations.rst | 2 +-
docs/system/arm/cpu-features.rst | 116 +++++++--------
docs/system/arm/nuvoton.rst | 2 +-
docs/system/arm/sbsa.rst | 4 +-
docs/system/arm/virt.rst | 2 +-
docs/system/cpu-hotplug.rst | 2 +-
docs/system/guest-loader.rst | 6 +-
docs/system/ppc/powernv.rst | 8 +-
docs/system/riscv/microchip-icicle-kit.rst | 2 +-
docs/system/riscv/virt.rst | 2 +-
docs/system/s390x/protvirt.rst | 12 +-
docs/tools/virtiofsd.rst | 2 +-
20 files changed, 204 insertions(+), 204 deletions(-)
--
2.20.1
- [PATCH for-6.1 00/10] docs: Format literals correctly in rST,
Peter Maydell <=
- [PATCH for-6.1 03/10] docs/devel/ebpf_rss.rst: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 04/10] docs/devel/migration.rst: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 02/10] docs/devel/build-system.rst: Correct typo in example code, Peter Maydell, 2021/07/26
- [PATCH for-6.1 01/10] docs/devel/build-system.rst: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 05/10] docs/devel: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 08/10] docs: Format literals correctly, Peter Maydell, 2021/07/26