From: Markus Armbruster <armbru@redhat.com>
To: John Snow <jsnow@redhat.com>
Cc: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>,
Michael Roth <michael.roth@amd.com>
Subject: Re: [PATCH 09/23] qapi/source: allow multi-line QAPISourceInfo advancing
Date: Fri, 20 Dec 2024 14:22:34 +0100 [thread overview]
Message-ID: <87h66y4hgl.fsf@pond.sub.org> (raw)
In-Reply-To: <20241213021827.2956769-10-jsnow@redhat.com> (John Snow's message of "Thu, 12 Dec 2024 21:18:12 -0500")
John Snow <jsnow@redhat.com> writes:
> This is for the sake of the new rST generator (the "transmogrifier") so
> we can advance multiple lines on occasion while keeping the
> generated<-->source mappings accurate.
>
> next_line now simply takes an optional n parameter which chooses the
> number of lines to advance.
>
>
> RFC: Here's the exorbitant detail on why I want this:
>
> This is used mainly when converting section syntax in free-form
> documentation to more traditional rST section header syntax, which
> does not always line up 1:1 for line counts.
>
> For example:
>
> ```
> ##
> # = Section <-- Info is pointing here, "L1"
> #
> # Lorem Ipsum
> ##
> ```
>
> would be transformed to rST as:
>
> ```
> ======= <-- L1
> Section <-- L1
> ======= <-- L1
> <-- L2
> Lorem Ipsum <-- L3
> ```
I can't help to wonder... Could we simply use rST markup instead?
"Later", "maybe later", or even "please ask me later" would be perfectly
acceptable answers.
> After consuming the single "Section" line from the source, we want to
> advance the source pointer to the next non-empty line which requires
> jumping by more than one line.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> scripts/qapi/source.py | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/scripts/qapi/source.py b/scripts/qapi/source.py
> index 7b379fdc925..ffdc3f482ac 100644
> --- a/scripts/qapi/source.py
> +++ b/scripts/qapi/source.py
> @@ -47,9 +47,9 @@ def set_defn(self, meta: str, name: str) -> None:
> self.defn_meta = meta
> self.defn_name = name
>
> - def next_line(self: T) -> T:
> + def next_line(self: T, n: int = 1) -> T:
> info = copy.copy(self)
> - info.line += 1
> + info.line += n
> return info
>
> def loc(self) -> str:
Assuming we need this:
Reviewed-by: Markus Armbruster <armbru@redhat.com>
next prev parent reply other threads:[~2024-12-20 13:23 UTC|newest]
Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-13 2:18 [PATCH 00/23] docs: add basic sphinx-domain rST generator to qapidoc John Snow
2024-12-13 2:18 ` [PATCH 01/23] docs/qapidoc: support header-less freeform sections John Snow
2024-12-16 13:15 ` Markus Armbruster
2025-01-13 19:12 ` John Snow
2025-01-14 9:19 ` Markus Armbruster
2024-12-13 2:18 ` [PATCH 02/23] qapi/parser: adjust info location for doc body section John Snow
2024-12-13 2:18 ` [PATCH 03/23] docs/qapidoc: remove example section support John Snow
2024-12-18 12:27 ` Markus Armbruster
2024-12-18 15:15 ` John Snow
2025-01-09 7:50 ` Markus Armbruster
2024-12-13 2:18 ` [PATCH 04/23] qapi: expand tags to all doc sections John Snow
2024-12-18 10:58 ` Markus Armbruster
2024-12-18 15:14 ` John Snow
2025-01-09 7:51 ` Markus Armbruster
2024-12-20 13:13 ` Markus Armbruster
2025-01-09 18:49 ` John Snow
2025-01-10 7:33 ` Markus Armbruster
2024-12-13 2:18 ` [PATCH 05/23] qapi/schema: add __repr__ to QAPIDoc.Section John Snow
2024-12-13 2:18 ` [PATCH 06/23] docs/qapidoc: add transmogrifier stub John Snow
2024-12-13 2:18 ` [PATCH 07/23] docs/qapidoc: add transmogrifier class stub John Snow
2024-12-13 2:18 ` [PATCH 08/23] docs/qapidoc: add visit_module() method John Snow
2024-12-13 2:18 ` [PATCH 09/23] qapi/source: allow multi-line QAPISourceInfo advancing John Snow
2024-12-20 13:22 ` Markus Armbruster [this message]
2025-01-08 21:18 ` John Snow
2025-01-09 8:00 ` Markus Armbruster
2025-01-09 17:19 ` John Snow
2025-01-10 7:37 ` Markus Armbruster
2024-12-13 2:18 ` [PATCH 10/23] docs/qapidoc: add visit_freeform() method John Snow
2024-12-20 13:25 ` Markus Armbruster
2025-01-13 20:14 ` John Snow
2024-12-13 2:18 ` [PATCH 11/23] docs/qapidoc: add preamble() method John Snow
2024-12-20 14:15 ` Markus Armbruster
2025-01-08 22:58 ` John Snow
2025-01-09 10:34 ` Markus Armbruster
2025-01-09 18:04 ` John Snow
2025-01-10 12:19 ` Markus Armbruster
2025-01-13 20:53 ` John Snow
2025-01-14 9:30 ` Markus Armbruster
2024-12-13 2:18 ` [PATCH 12/23] docs/qapidoc: add visit_paragraph() method John Snow
2024-12-13 2:18 ` [PATCH 13/23] docs/qapidoc: add visit_errors() method John Snow
2024-12-13 2:18 ` [PATCH 14/23] docs/qapidoc: add format_type() method John Snow
2024-12-13 2:18 ` [PATCH 15/23] docs/qapidoc: add add_field() and generate_field() helper methods John Snow
2024-12-13 2:18 ` [PATCH 16/23] docs/qapidoc: add visit_feature() method John Snow
2024-12-20 14:21 ` Markus Armbruster
2025-01-08 22:46 ` John Snow
2024-12-13 2:18 ` [PATCH 17/23] docs/qapidoc: record current documented entity in transmogrifier John Snow
2024-12-20 14:23 ` Markus Armbruster
2025-01-08 21:11 ` John Snow
2025-01-09 10:35 ` Markus Armbruster
2024-12-13 2:18 ` [PATCH 18/23] docs/qapidoc: add visit_returns() method John Snow
2024-12-13 2:18 ` [PATCH 19/23] docs/qapidoc: add visit_member() method John Snow
2024-12-13 2:18 ` [PATCH 20/23] docs/qapidoc: add visit_sections() method John Snow
2024-12-13 2:18 ` [PATCH 21/23] docs/qapidoc: add visit_entity() John Snow
2024-12-13 2:18 ` [PATCH 22/23] docs/qapidoc: implement transmogrify() method John Snow
2024-12-13 2:18 ` [PATCH 23/23] docs/qapidoc: add transmogrifier test document John Snow
2024-12-19 12:31 ` [PATCH 00/23] docs: add basic sphinx-domain rST generator to qapidoc Markus Armbruster
2025-01-08 21:08 ` John Snow
2025-01-09 11:48 ` Markus Armbruster
2025-01-09 17:26 ` John Snow
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=87h66y4hgl.fsf@pond.sub.org \
--to=armbru@redhat.com \
--cc=jsnow@redhat.com \
--cc=michael.roth@amd.com \
--cc=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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.