[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFH
From: |
Alex Bennée |
Subject: |
Re: [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING |
Date: |
Mon, 02 Mar 2020 12:17:58 +0000 |
User-agent: |
mu4e 1.3.9; emacs 27.0.90 |
Peter Maydell <address@hidden> writes:
> 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>
> ---
> 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)
--
Alex Bennée
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- Re: [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING,
Alex Bennée <=