From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Michael Roth" <michael.roth@amd.com>,
"Thomas Huth" <thuth@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Markus Armbruster" <armbru@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Cleber Rosa" <crosa@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"John Snow" <jsnow@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>
Subject: [PATCH 09/10] qapi/source: allow multi-line QAPISourceInfo advancing
Date: Sun, 23 Feb 2025 22:37:40 -0500 [thread overview]
Message-ID: <20250224033741.222749-10-jsnow@redhat.com> (raw)
In-Reply-To: <20250224033741.222749-1-jsnow@redhat.com>
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.
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 by the transmogrifier as:
```
======= <-- L1
Section <-- L1
======= <-- L1
<-- L2
Lorem Ipsum <-- L3
```
With each line having its own source information credited to different
source lines; sometimes one line to many.
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.
```
##
# = Section <-- Info is pointing here, "L1"
#
# Lorem Ipsum <-- We want to jump to here, +2.
##
```
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@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:
--
2.48.1
next prev parent reply other threads:[~2025-02-24 3:39 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-24 3:37 [PATCH 00/10] qapi: misc testing and doc patches John Snow
2025-02-24 3:37 ` [PATCH 01/10] qapi: update pylintrc config John Snow
2025-02-26 9:19 ` Markus Armbruster
2025-02-24 3:37 ` [PATCH 02/10] python: add qapi static analysis tests John Snow
2025-02-24 12:36 ` Markus Armbruster
2025-02-24 15:07 ` John Snow
2025-02-26 9:29 ` Markus Armbruster
2025-02-26 15:12 ` John Snow
2025-02-24 3:37 ` [PATCH 03/10] qapi: delete un-needed python static analysis configs John Snow
2025-02-24 12:43 ` Markus Armbruster
2025-02-26 7:23 ` Markus Armbruster
2025-02-26 7:27 ` Markus Armbruster
2025-02-26 15:05 ` John Snow
2025-02-27 7:05 ` Markus Armbruster
2025-02-24 3:37 ` [PATCH 04/10] docs/qapidoc: support header-less freeform sections John Snow
2025-02-24 12:45 ` Markus Armbruster
2025-02-26 9:36 ` Markus Armbruster
2025-02-26 15:28 ` John Snow
2025-02-24 3:37 ` [PATCH 05/10] qapi/parser: adjust info location for doc body section John Snow
2025-02-25 8:15 ` Markus Armbruster
2025-02-24 3:37 ` [PATCH 06/10] docs/qapidoc: remove example section support John Snow
2025-02-26 9:38 ` Markus Armbruster
2025-02-24 3:37 ` [PATCH 07/10] qapi: expand tags to all doc sections John Snow
2025-02-28 12:37 ` Markus Armbruster
2025-02-24 3:37 ` [PATCH 08/10] qapi/schema: add __repr__ to QAPIDoc.Section John Snow
2025-02-24 3:37 ` John Snow [this message]
2025-02-24 3:37 ` [PATCH 10/10] docs: disambiguate cross-references John Snow
2025-02-26 10:09 ` [PATCH 00/10] qapi: misc testing and doc patches Markus Armbruster
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=20250224033741.222749-10-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=crosa@redhat.com \
--cc=michael.roth@amd.com \
--cc=peter.maydell@linaro.org \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=thuth@redhat.com \
/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).