From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Subject: [PULL 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING
Date: Fri, 6 Mar 2020 11:09:48 +0000 [thread overview]
Message-ID: <20200306110959.29461-23-peter.maydell@linaro.org> (raw)
In-Reply-To: <20200306110959.29461-1-peter.maydell@linaro.org>
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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Tested-by: Alex Bennée <alex.bennee@linaro.org>
Message-id: 20200228153619.9906-23-peter.maydell@linaro.org
---
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
next prev parent reply other threads:[~2020-03-06 11:17 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-06 11:09 [PULL 00/33] docs queue Peter Maydell
2020-03-06 11:09 ` [PULL 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual Peter Maydell
2020-03-06 11:09 ` [PULL 02/33] qemu-doc: remove target OS documentation Peter Maydell
2020-03-06 11:09 ` [PULL 03/33] texi2pod: parse @include directives outside "@c man" blocks Peter Maydell
2020-03-06 11:09 ` [PULL 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts Peter Maydell
2020-03-06 11:09 ` [PULL 05/33] qemu-doc: split qemu-doc.texi in multiple files Peter Maydell
2020-03-06 11:09 ` [PULL 06/33] qemu-doc: extract common system emulator documentation from the PC section Peter Maydell
2020-03-06 11:09 ` [PULL 07/33] qemu-doc: move system requirements chapter inside " Peter Maydell
2020-03-06 11:09 ` [PULL 08/33] qemu-doc: split target sections to separate files Peter Maydell
2020-03-06 11:09 ` [PULL 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes" Peter Maydell
2020-03-06 11:09 ` [PULL 10/33] qemu-doc: move qemu-tech.texi into main section Peter Maydell
2020-03-06 11:09 ` [PULL 11/33] qemu-doc: move included files to docs/system Peter Maydell
2020-03-06 11:09 ` [PULL 12/33] qemu-doc: remove indices other than findex Peter Maydell
2020-03-06 11:09 ` [PULL 13/33] docs/system: put qemu-block-drivers body in an included file Peter Maydell
2020-03-06 11:09 ` [PULL 14/33] docs: Create defs.rst.inc as a place to define substitutions Peter Maydell
2020-03-06 11:09 ` [PULL 15/33] docs/system: Convert qemu-cpu-models.texi to rST Peter Maydell
2020-03-06 11:09 ` [PULL 16/33] docs/system: Convert security.texi to rST format Peter Maydell
2020-03-06 11:09 ` [PULL 17/33] docs/system: convert managed startup to rST Peter Maydell
2020-03-06 11:09 ` [PULL 18/33] docs/system: convert the documentation of deprecated features " Peter Maydell
2020-03-06 11:09 ` [PULL 19/33] docs/system: convert Texinfo documentation " Peter Maydell
2020-03-06 11:09 ` [PULL 20/33] hmp-commands.hx: Add rST documentation fragments Peter Maydell
2020-03-06 11:09 ` [PULL 21/33] hmp-commands-info.hx: " Peter Maydell
2020-03-06 11:09 ` Peter Maydell [this message]
2020-03-06 11:09 ` [PULL 23/33] docs: Roll semihosting option information into qemu-options.hx Peter Maydell
2020-03-06 11:09 ` [PULL 24/33] docs: Roll -prom-env and -g target-specific info " Peter Maydell
2020-03-06 11:09 ` [PULL 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion Peter Maydell
2020-03-06 11:09 ` [PULL 26/33] qemu-options.hx: Add rST documentation fragments Peter Maydell
2020-03-06 11:09 ` [PULL 27/33] qemu-options.hx: Fix up the autogenerated rST Peter Maydell
2020-03-06 11:09 ` [PULL 28/33] docs: Split out sections for the manpage into .rst.inc files Peter Maydell
2020-03-06 11:09 ` [PULL 29/33] docs: Generate qemu.1 manpage with Sphinx Peter Maydell
2020-03-06 11:09 ` [PULL 30/33] ui/cocoa.m: Update documentation file and pathname Peter Maydell
2020-03-06 11:09 ` [PULL 31/33] docs: Stop building qemu-doc Peter Maydell
2020-03-06 11:09 ` [PULL 32/33] docs: Remove old texinfo sources Peter Maydell
2020-03-06 11:09 ` [PULL 33/33] *.hx: Remove all the STEXI/ETEXI blocks Peter Maydell
2020-03-06 11:37 ` [PULL 00/33] docs queue no-reply
2020-03-06 11:52 ` Peter Maydell
2020-03-06 11:55 ` no-reply
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=20200306110959.29461-23-peter.maydell@linaro.org \
--to=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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).