t annotations into captions manually.
(Tedious, oh well.)
3. Add captions where still needed:
sed -zi 's|# .. code-block:: QMP\n#\n|# .. code-block:: QMP\n#:caption:
Example\n#\n|g' *.json
Not fully ideal, but hopefully not something that has to be
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.
Signed-o
Add a semantic tag to paragraphs that appear *before* tagged
sections/members/features and those that appear after. This will control
how they are inlined when doc sections are merged and flattened.
Signed-off-by: John Snow
---
scripts/qapi/parser.py | 22 +-
1 file changed
Instead of using the info object for the doc block as a whole, update
the info pointer for each call to ensure_untagged_section when the
existing section is otherwise empty. This way, Sphinx error information
will match precisely to where the text actually starts.
Signed-off-by: John Snow
for rST.)
Signed-off-by: John Snow
---
docs/sphinx/qapidoc.py | 36 +-
scripts/qapi/parser.py | 8 ++--
tests/qapi-schema/doc-good.out | 32 +++---
3 files changed, 53 insertions(+), 23 deletions(-)
diff --git a/docs/sphinx
Rewrite the StatsFilter intro paragraph to be more meaningful to
end-users when it is inlined in generated documentation.
Signed-off-by: John Snow
---
qapi/stats.json | 8 ++--
1 file changed, 2 insertions(+), 6 deletions(-)
diff --git a/qapi/stats.json b/qapi/stats.json
index 578b52c7ef7
This helps simplify the doc generator if it doesn't have to check for
undocumented members.
Signed-off-by: John Snow
---
scripts/qapi/parser.py | 20 ++--
1 file changed, 18 insertions(+), 2 deletions(-)
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
iants else []:
...
against:
for var in variants or []:
...
Update callsites to reflect the new usage pattern.
Signed-off-by: John Snow
---
docs/sphinx/qapidoc.py | 2 +-
scripts/qapi/introspect.py | 4 ++--
scripts/qapi/schema.py | 8 ++--
scripts/qapi/types.py
parsing an untagged section (free paragraphs), skip making a hollow
section and instead append the parse results to the prior section.
Many Bothans died to bring us this information.
Signed-off-by: John Snow
---
docs/sphinx/qapidoc.py | 16 +++-
1 file changed, 11 insertions(+), 5
ttle to no use to *either*
audience, and convert what's left to garden-variety comments to prevent
it from showing up in rendered documentation.
Signed-off-by: John Snow
---
qapi/audio.json| 5 ++---
qapi/block-core.json | 47 ++
qapi/block-ex
:
.. Note:: ...
.. admonition:: custom title
admonition body text
This patch uses ".. notes::" almost everywhere, with just two "caution"
directives. ".. admonition:: notes" is used in a few places where we had
an ordered list of multiple notes.
Signed-off-
ot;pip install black" (without root permissions) if
you do not have it installed otherwise.
Signed-off-by: John Snow
---
docs/sphinx/qapidoc.py | 16 +---
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index f270b494f
t;, so two examples have been adjusted to support that
format here.
Signed-off-by: John Snow
---
qapi/control.json | 3 ++-
qapi/machine.json | 2 +-
qapi/migration.json | 2 +-
qapi/misc.json | 3 ++-
qapi/net.json | 6 +++---
qapi/rocker.json| 2 +-
qapi/ui.json| 2 +
If a comment immediately follows a doc block, the parser doesn't ignore
that token appropriately. Fix that.
Signed-off-by: John Snow
---
scripts/qapi/parser.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 41b931
after this series. Sorry about that!
Signed-off-by: John Snow
---
scripts/qapi-lint.sh | 51 +++
scripts/qapi/Makefile | 5 +
2 files changed, 56 insertions(+)
create mode 100755 scripts/qapi-lint.sh
create mode 100644 scripts/qapi/Makefile
diff
Rephrase this paragraph so that it can apply to any commands that
inherit from this object.
Signed-off-by: John Snow
---
qapi/block-export.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/qapi/block-export.json b/qapi/block-export.json
index dc328097a94
Transactions have the only instance of an Errors section that isn't a
rST list; turn it into one.
Signed-off-by: John Snow
---
qapi/transaction.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/qapi/transaction.json b/qapi/transaction.json
index 5749c133d4a..07afc2
ll_sections, we need *something* accessible to distinguish them.
To keep types simple, add this semantic parameter to the base Section
and not just ArgSection; we can use this to filter out paragraphs and
tagged sections, too.
Signed-off-by: John Snow
---
scripts/qapi/parser.py | 25 +
On Wed, May 15, 2024, 5:17 AM Markus Armbruster wrote:
> John Snow writes:
>
> > In the coming patches, it's helpful to have a linting baseline. However,
> > there's no need to shuffle around the deck chairs too much, because most
> > of this code will be remo
On Wed, May 15, 2024, 7:50 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Prior to this patch, a section like this:
> >
> > @name: lorem ipsum
> >dolor sit amet
> > consectetur adipiscing elit
> >
> > would be parsed as:
>
On Wed, May 15, 2024 at 5:17 AM Markus Armbruster wrote:
> John Snow writes:
>
> > In the coming patches, it's helpful to have a linting baseline. However,
> > there's no need to shuffle around the deck chairs too much, because most
> > of this code wi
On Wed, May 15, 2024 at 10:18 AM Markus Armbruster
wrote:
> John Snow writes:
>
> > On Wed, May 15, 2024, 7:50 AM Markus Armbruster
> wrote:
> >
> >> John Snow writes:
> >>
> >> > Prior to this patch, a section like this:
> &
On Wed, May 15, 2024, 1:27 PM Markus Armbruster wrote:
> John Snow writes:
>
> > On Wed, May 15, 2024 at 5:17 AM Markus Armbruster
> wrote:
> >
> >> John Snow writes:
> >>
> >> > In the coming patches, it's helpful to have a lintin
On Thu, May 16, 2024, 1:58 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Instead of using the info object for the doc block as a whole, update
> > the info pointer for each call to ensure_untagged_section when the
> > existing section is otherwise empty
On Thu, May 16, 2024, 2:18 AM Markus Armbruster wrote:
> John Snow writes:
>
> > When iterating all_sections, this is helpful to be able to distinguish
> > "members" from "features"; the only other way to do so is to
> > cross-reference these secti
On Thu, May 16, 2024, 5:34 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Add a semantic tag to paragraphs that appear *before* tagged
> > sections/members/features and those that appear after. This will control
> > how they are inlined when doc sections
On Thu, May 16, 2024 at 2:01 AM Markus Armbruster wrote:
> John Snow writes:
>
> > If a comment immediately follows a doc block, the parser doesn't ignore
> > that token appropriately. Fix that.
>
> Reproducer?
>
> >
> > Signed-off-by: John S
On Thu, May 16, 2024 at 11:06 AM John Snow wrote:
>
>
> On Thu, May 16, 2024, 5:34 AM Markus Armbruster wrote:
>
>> John Snow writes:
>>
>> > Add a semantic tag to paragraphs that appear *before* tagged
>> > sections/members/features and those that app
On Thu, Jun 13, 2024 at 10:32 AM Markus Armbruster
wrote:
> John Snow writes:
>
> > On Thu, May 16, 2024 at 2:01 AM Markus Armbruster
> wrote:
> >
> >> John Snow writes:
> >>
> >> > If a comment immediately follows a doc block, the parser do
On Thu, Jun 13, 2024 at 10:46 AM Markus Armbruster
wrote:
> John Snow writes:
>
> > On Thu, May 16, 2024, 2:18 AM Markus Armbruster
> wrote:
> >
> >> John Snow writes:
> >>
> >> > When iterating all_sections, this is helpful to be able to dis
On Fri, Jun 14, 2024 at 4:53 AM Markus Armbruster wrote:
> John Snow writes:
>
> > This helps simplify the doc generator if it doesn't have to check for
> > undocumented members.
> >
> > Signed-off-by: John Snow
> > ---
> > scripts/qapi/parser.p
On Fri, Jun 14, 2024, 5:40 AM Markus Armbruster wrote:
> John Snow writes:
>
> > The intent here is to mark only certain definitions as visible in the
> > end-user docs.
> >
> > All commands and events are inherently visible. Everything else is
> > visible
On Fri, Jun 14, 2024, 5:46 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Sphinx does not like sections without titles, because it wants to
> > convert every section into a reference. When there is no title, it
> > struggles to do this and transf
On Fri, Jun 14, 2024, 6:55 AM Markus Armbruster wrote:
> John Snow writes:
>
> > If we parse all examples as QMP, we need them to conform to a standard
> > so that they render correctly. Once the QMP lexer is active for
> > examples, these will produce warning mes
On Fri, Jun 14, 2024, 7:24 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Transactions have the only instance of an Errors section that isn't a
> > rST list; turn it into one.
>
> Just for consistency? Or do you have other shenanigans up your sleeve?
>
On Fri, Jun 14, 2024, 9:44 AM Markus Armbruster wrote:
> John Snow writes:
>
> > We do not need a dedicated section for notes. By eliminating a specially
> > parsed section, these notes can be treated as normal rST paragraphs in
> > the new QMP reference manual, and
On Fri, Jun 14, 2024 at 10:39 AM Markus Armbruster
wrote:
> John Snow writes:
>
> > Eliminate the "Example" sections in QAPI doc blocks, converting them
> > into QMP example code blocks. This is generally done by converting
> > "Example:" or "
les is a little ugly in rendered HTML
output; My CSS intern wasn't available before publication time to fix
it ;) -- Will fix with an amendment patch at next opportunity.
Any feedback not implemented should be interpreted as evidence of a
forgetful (rather than a spiteful) mind. Please re
Fix minor irritants to pylint/flake8 et al.
(Yes, these need to be guarded by the Python tests. That's a work in
progress, a series that's quite likely to follow once I finish this
Sphinx project. Please pardon the temporary irritation.)
Signed-off-by: John Snow
Reviewed-by: Markus
tion (free paragraphs), skip making a hollow
section and instead append the parse results to the prior section.
Many Bothans died to bring us this information.
Signed-off-by: John Snow
---
docs/sphinx/qapidoc.py | 16 +++-
1 file changed, 11 insertions(+), 5 deletions(-)
diff --git a/d
llows a doc block.
Fixes: 3d035cd2cca6 (qapi: Rewrite doc comment parser)
Signed-off-by: John Snow
---
scripts/qapi/parser.py | 2 +-
tests/qapi-schema/doc-good.json | 2 ++
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 43167e
am.
Signed-off-by: John Snow
---
docs/sphinx/qapidoc.py | 66 +-
1 file changed, 40 insertions(+), 26 deletions(-)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index f270b494f01..e675966defa 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sp
here, with just two "caution"
directives. ".. admonition:: notes" is used in a few places where we had
an ordered list of multiple notes that would not make sense as
standalone/separate admonitions.
Signed-off-by: John Snow
Acked-by: Stefan Hajnoczi [for block*.json]
---
een adjusted to support that
format here.
Signed-off-by: John Snow
---
qapi/control.json | 3 ++-
qapi/machine.json | 2 +-
qapi/migration.json | 2 +-
qapi/misc.json | 3 ++-
qapi/net.json | 6 +++---
qapi/rocker.json| 2 +-
qapi/ui.json| 2 +-
7 files changed, 11 inserti
Transactions have the only instance of an Errors section that isn't a
rST list; turn it into one.
Signed-off-by: John Snow
---
docs/devel/qapi-code-gen.rst | 7 +++
qapi/transaction.json| 2 +-
2 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/docs/devel/qapi
after this series. Sorry about that!
Signed-off-by: John Snow
---
scripts/qapi-lint.sh | 59 +++
scripts/qapi/Makefile | 5
2 files changed, 64 insertions(+)
create mode 100755 scripts/qapi-lint.sh
create mode 100644 scripts/qapi/Makefile
diff
masse in a subsequent patch
after the new QAPI doc generator is merged.
Signed-off-by: John Snow
---
qapi/control.json | 4 ++--
qapi/misc.json | 8
qapi/qdev.json | 2 +-
qapi/run-state.json | 2 +-
qapi/sockets.json | 2 +-
qapi/ui.json| 2 +-
6 files changed, 10
Where I've noticed, rephrase the note to read more fluently.
Signed-off-by: John Snow
---
qapi/block-core.json | 4 ++--
qga/qapi-schema.json | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index cacedfb771c..9ef23ec02ae 1
anual/interop/qemu-storage-daemon-qmp-ref.html
Signed-off-by: John Snow
---
docs/sphinx/qapidoc.py | 29 -
scripts/qapi/parser.py | 5 +++--
tests/qapi-schema/doc-good.out | 32
3 files changed, 43 insertions(+), 23 dele
The double-colon synax is rST formatting that precedes a literal code
block. We do not want to capture these as QAPI-specific sections.
Coerce blocks that start with e.g. "Example::" to be parsed as untagged
paragraphs instead of special tagged sections.
Signed-off-by: John Snow
--
ons that no longer parse successfully by attempting the
doc build, convert annotations into captions manually.
(Tedious, oh well.)
3. Add captions where still needed:
sed -zi 's|# .. code-block:: QMP\n#\n|# .. code-block:: QMP\n#:caption:
Example\n#\n|g' *.json
Not fully ideal, but
On Wed, Jun 19, 2024, 2:28 AM Markus Armbruster wrote:
> John Snow writes:
>
> > In a forthcoming series that adds a new QMP documentation generator, it
> > will be helpful to have a linting baseline. However, there's no need to
> > shuffle around the deck chairs t
On Wed, Jun 19, 2024, 9:20 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Eliminate the "Example" sections in QAPI doc blocks, converting them
> > into QMP example code blocks. This is generally done in this patch by
> > converting "Example:&qu
On Wed, Jun 19, 2024, 8:03 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Change get_doc_indented() to preserve indentation on all subsequent text
> > lines, and create a compatibility dedent() function for qapidoc.py to
> > remove that indentation. This is being
On Thu, Jun 20, 2024, 11:07 AM Markus Armbruster wrote:
> John Snow writes:
>
> > On Wed, Jun 19, 2024, 8:03 AM Markus Armbruster
> wrote:
> >
> >> John Snow writes:
> >>
> >> > Change get_doc_indented() to preserve indentation on all subsequ
On Wed, Jun 19, 2024, 8:10 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Transactions have the only instance of an Errors section that isn't a
> > rST list; turn it into one.
> >
> > Signed-off-by: John Snow
>
> Let;s explain the "why"
On Wed, Jun 19, 2024, 8:49 AM Markus Armbruster wrote:
> John Snow writes:
>
> > We do not need a dedicated section for notes. By eliminating a specially
> > parsed section, these notes can be treated as normal rST paragraphs in
> > the new QMP reference manual, and
On Wed, Jun 19, 2024, 9:07 AM Markus Armbruster wrote:
> John Snow writes:
>
> > We do not need a dedicated section for notes. By eliminating a specially
> > parsed section, these notes can be treated as normal rST paragraphs in
> > the new QMP reference manual, and
On Thu, Jun 20, 2024, 9:35 AM Markus Armbruster wrote:
> Markus Armbruster writes:
>
> > John Snow writes:
>
> [...]
>
> >> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> >> index b3de1fb6b3a..57598331c5c 100644
> >> --- a/qga/
On Thu, Jun 20, 2024, 9:55 AM Markus Armbruster wrote:
> John Snow writes:
>
> > We do not need a dedicated section for notes. By eliminating a specially
> > parsed section, these notes can be treated as normal rST paragraphs in
> > the new QMP reference manual, and
On Thu, Jun 20, 2024 at 11:46 AM John Snow wrote:
>
>
> On Thu, Jun 20, 2024, 9:35 AM Markus Armbruster wrote:
>
>> Markus Armbruster writes:
>>
>> > John Snow writes:
>>
>> [...]
>>
>> >> diff --git a/qga/qapi-schema.json b/q
On Fri, Jun 21, 2024 at 2:38 AM Markus Armbruster wrote:
> John Snow writes:
>
> > On Thu, Jun 20, 2024, 11:07 AM Markus Armbruster
> wrote:
> >
> >> John Snow writes:
> >>
> >> > On Wed, Jun 19, 2024, 8:03 AM Markus Ar
On Fri, Jun 21, 2024 at 8:08 AM Markus Armbruster wrote:
> John Snow writes:
>
> > We do not need a dedicated section for notes. By eliminating a specially
> > parsed section, these notes can be treated as normal rST paragraphs in
> > the new QMP reference manual, and
On Fri, Jun 21, 2024 at 8:23 AM Markus Armbruster wrote:
> John Snow writes:
>
> > On Thu, Jun 20, 2024 at 11:46 AM John Snow wrote:
> >
> >>
> >>
> >> On Thu, Jun 20, 2024, 9:35 AM Markus Armbruster
> wrote:
> >>
> &g
On Mon, May 27, 2024 at 7:58 AM Markus Armbruster wrote:
> John Snow writes:
>
> > On Thu, May 16, 2024, 1:58 AM Markus Armbruster
> wrote:
> >
> >> John Snow writes:
> >>
> >> > Instead of using the info object for the doc block as a who
On Wed, Jun 26, 2024, 1:18 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Eliminate the "Example" sections in QAPI doc blocks, converting them
> > into QMP example code blocks. This is generally done in this patch by
> > converting "Example:&qu
ox styling and sphinx directive macro
- Addressed... most? list feedback. (But not the indent split.)
Known issues:
- The Example boxes are styled a little wonkily if prose follows the
code-block instead of precedes it, fixup will be tomorrow.
--js
Harmonie Snow (1):
docs/sphinx: add CSS stylin
This function has been unused since fd62bff901b.
Signed-off-by: John Snow
---
docs/sphinx/qapidoc.py | 10 --
1 file changed, 10 deletions(-)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index f270b494f01..3c0565d0ceb 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs
will not be needed any longer and can be
dropped.
Signed-off-by: John Snow
[Edited commit message and code comments per review --js]
Reviewed-by: Markus Armbruster
---
docs/sphinx/qapidoc.py | 27 ++-
scripts/qapi/parser.py | 4 ++--
tests/qapi-schema/doc
By unstated convention, Errors sections are rST lists. Document the
convention, and make the one exception conform.
Signed-off-by: John Snow
Reviewed-by: Markus Armbruster
---
docs/devel/qapi-code-gen.rst | 7 +++
qapi/transaction.json| 2 +-
2 files changed, 8 insertions(+), 1
examples have been
adjusted to support that format here.
Signed-off-by: John Snow
Reviewed-by: Markus Armbruster
---
qapi/control.json | 3 ++-
qapi/machine.json | 2 +-
qapi/migration.json | 2 +-
qapi/misc.json | 3 ++-
qapi/net.json | 6 +++---
qapi/rocker.json| 2 +-
qapi/ui.
llows a doc block.
Fixes: 3d035cd2cca6 (qapi: Rewrite doc comment parser)
Signed-off-by: John Snow
Reviewed-by: Markus Armbruster
---
scripts/qapi/parser.py | 2 +-
tests/qapi-schema/doc-good.json | 2 ++
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/scripts/qapi/parser.py b/scr
Where I've noticed, rephrase the note to read more fluently.
Signed-off-by: John Snow
Reviewed-by: Markus Armbruster
---
qapi/block-core.json | 4 ++--
qga/qapi-schema.json | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
am.
Signed-off-by: John Snow
Reviewed-by: Markus Armbruster
---
docs/sphinx/qapidoc.py | 62 +-
1 file changed, 37 insertions(+), 25 deletions(-)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index 3c0565d0ceb..659e507353a 100644
--
ve syntax.
See commit+2: "qapi: remove "Example" doc section" for a detailed
explanation of why.
Signed-off-by: John Snow
---
qapi/block-core.json | 24
qapi/block.json | 13 ++---
qapi/migration.json | 25 ++---
masse in a subsequent patch
after the new QAPI doc generator is merged.
Signed-off-by: John Snow
Reviewed-by: Markus Armbruster
---
qapi/control.json | 4 ++--
qapi/misc.json | 8
qapi/qdev.json | 2 +-
qapi/run-state.json | 2 +-
qapi/sockets.json | 2 +-
qapi/ui.json
after this series. Sorry about that!
Signed-off-by: John Snow
---
scripts/qapi-lint.sh | 61 +++
scripts/qapi/Makefile | 5
2 files changed, 66 insertions(+)
create mode 100755 scripts/qapi-lint.sh
create mode 100644 scripts/qapi/Makefile
diff
From: Harmonie Snow
Add CSS styling for qmp-example directives to increase readability and
consistently style all example blocks.
Signed-off-by: Harmonie Snow
Signed-off-by: John Snow
---
docs/sphinx-static/theme_overrides.css | 46 ++
1 file changed, 46 insertions
; }
```
But instead, simply:
```
.. qmp-example::
:annotated:
Blah blah::
-> { "lorem": "ipsum" }
```
Once the directive block is exited, whatever the previous default
highlight language was will be restored; localizing the forced QMP
lexing to exclusively this dir
Factor out the compatibility parser helper so it can be shared by other
directives.
Signed-off-by: John Snow
---
docs/sphinx/qapidoc.py | 64 +++---
1 file changed, 35 insertions(+), 29 deletions(-)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx
The double-colon synax is rST formatting that precedes a literal code
block. We do not want to capture these as QAPI-specific sections.
Coerce blocks that start with e.g. "Example::" to be parsed as untagged
paragraphs instead of special tagged sections.
Signed-off-by: John Snow
--
mit+3: "qapi: remove "Example" doc section" for a detailed
explanation of why.
Signed-off-by: John Snow
---
qapi/acpi.json | 4 +--
qapi/block-core.json | 64 +---
qapi/block.json | 18 ++
gged section" to an
"untagged section" means that rendering order for some notes *may
change* as a result of this patch. The forthcoming qapidoc.py rewrite
strictly preserves source ordering in the rendered documentation, so
this issue will be rectified in the new generator.
Sign
Fix minor irritants to pylint/flake8 et al.
(Yes, these need to be guarded by the Python tests. That's a work in
progress, a series that's quite likely to follow once I finish this
Sphinx project. Please pardon the temporary irritation.)
Signed-off-by: John Snow
Reviewed-by: Markus
that was
better to convert all at once.
See commit-5: "docs/qapidoc: create qmp-example directive", for a
detailed explanation of this custom directive syntax.
See commit+1: "qapi: remove "Example" doc section" for a detailed
explanation of w
tion (free paragraphs), skip making a hollow
section and instead append the parse results to the prior section.
Many Bothans died to bring us this information.
Signed-off-by: John Snow
Acked-by: Markus Armbruster
---
docs/sphinx/qapidoc.py | 16 +++-
1 file changed, 11 insertions(+), 5
lly valid examples.)
NOTE: As with the "Notes" conversion patch, this patch (and those
preceding) may change the rendering order for Examples in the
current generator. The forthcoming qapidoc rewrite will fix this
by always generating documentation in source order.
Signe
his commit, the code-block rST syntax "::" does not
apply QMP highlighting; you would need to use ".. code-block:: QMP". The
very next commit changes this behavior to assume all "::" code blocks
within this directive are QMP blocks.
Signed-off-by: Joh
Python 3.13 isn't out yet, but it's in beta and Fedora is ramping up to
make it the default system interpreter for Fedora 41.
They moved our cheese for where ContextManager lives; add a conditional
to locate it while we support both pre-3.9 and 3.13+.
Signed-off-by: John Snow
---
Python 3.13 is in beta and Fedora 41 is preparing to make it the default
system interpreter; enable testing for it.
(In the event problems develop prior to release, it should only impact
the check-python-tox job, which is not run by default and is allowed to
fail.)
Signed-off-by: John Snow
There is a bug in this version,
see: https://github.com/pylint-dev/pylint/issues/9751
Signed-off-by: John Snow
---
python/setup.cfg | 1 +
1 file changed, 1 insertion(+)
diff --git a/python/setup.cfg b/python/setup.cfg
index 48668609d3e..8ebd345d7ed 100644
--- a/python/setup.cfg
+++ b/python
ng variable 'sock' before
assignment (possibly-used-before-assignment)
qemu/utils/qemu_ga_client.py:168:4: R1711: Useless return at end of function or
method (useless-return)
Signed-off-by: John Snow
---
python/qemu/machine/machine.py | 1 +
python/qemu/utils/qemu_ga_client.py | 2 +-
jsnow/qemu/-/pipelines/1349737188
John Snow (4):
python: linter changes for pylint 3.x
python: Do not use pylint 3.2.4 with python 3.8
iotests: Change imports for Python 3.13
python: enable testing for 3.13
python/qemu/machine/machine.py | 1 +
python/qemu/utils/qemu_ga_client
On Thu, Jun 27, 2024, 2:02 AM Markus Armbruster wrote:
> John Snow writes:
>
> > This function has been unused since fd62bff901b.
> >
> > Signed-off-by: John Snow
>
> Reviewed-by: Markus Armbruster
>
> I assume you won't mind me adding a bit of po
On Thu, Jun 27, 2024, 2:25 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Change get_doc_indented() to preserve indentation on all subsequent text
> > lines, and create a compatibility dedent() function for qapidoc.py that
> > removes indentation the same wa
On Fri, Jun 28, 2024, 3:29 AM Markus Armbruster wrote:
> John Snow writes:
>
> > In a forthcoming series that adds a new QMP documentation generator, it
> > will be helpful to have a linting baseline. However, there's no need to
> > shuffle around the deck chairs t
On Fri, Jun 28, 2024, 3:55 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Sphinx does not like sections without titles, because it wants to
> > convert every section into a reference. When there is no title, it
> > struggles to do this and transf
On Fri, Jun 28, 2024, 9:09 AM Markus Armbruster wrote:
> John Snow writes:
>
> > Factor out the compatibility parser helper so it can be shared by other
> > directives.
>
> Suggest "Factor out the compatibility parser helper into a base class,
> so it can be sha
On Fri, Jun 28, 2024, 9:24 AM Markus Armbruster wrote:
> John Snow writes:
>
> > This is a directive that creates a syntactic sugar for creating
> > "Example" boxes very similar to the ones already used in the bitmaps.rst
> > document, please see e.g.
>
On Fri, Jun 28, 2024, 11:10 AM John Snow wrote:
>
>
> On Fri, Jun 28, 2024, 3:55 AM Markus Armbruster wrote:
>
>> John Snow writes:
>>
>> > Sphinx does not like sections without titles, because it wants to
>> > convert every section into a reference.
1 - 100 of 5916 matches
Mail list logo
