[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/A
From: |
Peter Maydell |
Subject: |
[PULL 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING |
Date: |
Fri, 6 Mar 2020 11:09:48 +0000 |
In hxtool files, section headings defined with the DEFHEADING
and ARCHHEADING macros have a trailing ':'
DEFHEADING(Standard options:)
This is for the benefit of the --help output. For consistency
with the rest of the rST documentation, strip any trailing ':'
when we construct headings with the Sphinx hxtool extension.
This makes the table of contents look neater.
This only affects generation of documentation from qemu-options.hx,
which we will start doing in a later commit.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
---
docs/sphinx/hxtool.py | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/docs/sphinx/hxtool.py b/docs/sphinx/hxtool.py
index 5d6736f3002..7dd223fe362 100644
--- a/docs/sphinx/hxtool.py
+++ b/docs/sphinx/hxtool.py
@@ -60,8 +60,9 @@ def parse_defheading(file, lnum, line):
# empty we ignore the directive -- these are used only to add
# blank lines in the plain-text content of the --help output.
#
- # Return the heading text
- match = re.match(r'DEFHEADING\((.*)\)', line)
+ # Return the heading text. We strip out any trailing ':' for
+ # consistency with other headings in the rST documentation.
+ match = re.match(r'DEFHEADING\((.*?):?\)', line)
if match is None:
serror(file, lnum, "Invalid DEFHEADING line")
return match.group(1)
@@ -72,8 +73,9 @@ def parse_archheading(file, lnum, line):
# though note that the 'some string' could be the empty string.
# As with DEFHEADING, empty string ARCHHEADINGs will be ignored.
#
- # Return the heading text
- match = re.match(r'ARCHHEADING\((.*),.*\)', line)
+ # Return the heading text. We strip out any trailing ':' for
+ # consistency with other headings in the rST documentation.
+ match = re.match(r'ARCHHEADING\((.*?):?,.*\)', line)
if match is None:
serror(file, lnum, "Invalid ARCHHEADING line")
return match.group(1)
--
2.20.1
- [PULL 12/33] qemu-doc: remove indices other than findex, (continued)
- [PULL 12/33] qemu-doc: remove indices other than findex, Peter Maydell, 2020/03/06
- [PULL 14/33] docs: Create defs.rst.inc as a place to define substitutions, Peter Maydell, 2020/03/06
- [PULL 17/33] docs/system: convert managed startup to rST., Peter Maydell, 2020/03/06
- [PULL 16/33] docs/system: Convert security.texi to rST format, Peter Maydell, 2020/03/06
- [PULL 08/33] qemu-doc: split target sections to separate files, Peter Maydell, 2020/03/06
- [PULL 13/33] docs/system: put qemu-block-drivers body in an included file, Peter Maydell, 2020/03/06
- [PULL 15/33] docs/system: Convert qemu-cpu-models.texi to rST, Peter Maydell, 2020/03/06
- [PULL 21/33] hmp-commands-info.hx: Add rST documentation fragments, Peter Maydell, 2020/03/06
- [PULL 05/33] qemu-doc: split qemu-doc.texi in multiple files, Peter Maydell, 2020/03/06
- [PULL 18/33] docs/system: convert the documentation of deprecated features to rST., Peter Maydell, 2020/03/06
- [PULL 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING,
Peter Maydell <=
- [PULL 24/33] docs: Roll -prom-env and -g target-specific info into qemu-options.hx, Peter Maydell, 2020/03/06
- [PULL 23/33] docs: Roll semihosting option information into qemu-options.hx, Peter Maydell, 2020/03/06
- [PULL 20/33] hmp-commands.hx: Add rST documentation fragments, Peter Maydell, 2020/03/06
- [PULL 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion, Peter Maydell, 2020/03/06
- [PULL 27/33] qemu-options.hx: Fix up the autogenerated rST, Peter Maydell, 2020/03/06
- [PULL 29/33] docs: Generate qemu.1 manpage with Sphinx, Peter Maydell, 2020/03/06
- [PULL 19/33] docs/system: convert Texinfo documentation to rST, Peter Maydell, 2020/03/06
- [PULL 28/33] docs: Split out sections for the manpage into .rst.inc files, Peter Maydell, 2020/03/06
- [PULL 31/33] docs: Stop building qemu-doc, Peter Maydell, 2020/03/06
- [PULL 30/33] ui/cocoa.m: Update documentation file and pathname, Peter Maydell, 2020/03/06