* [PATCH 0/4] HMP: hxtool sanity checks
@ 2026-01-15 2:04 dave
2026-01-15 2:04 ` [PATCH 1/4] hmp-commands-info.hx: Move definition of "info accel" dave
` (4 more replies)
0 siblings, 5 replies; 12+ messages in thread
From: dave @ 2026-01-15 2:04 UTC (permalink / raw)
To: dave, armbru, berrange; +Cc: qemu-devel
From: "Dr. David Alan Gilbert" <dave@treblig.org>
Hi,
This adds a couple of sanity checks to hxtool to try and catch the
type of mistake that Markus' patch fixes.
(Included Markus' patch since otherwise the script correctly fails)
Dave
Dr. David Alan Gilbert (3):
hmp*hx: Move info docs
hxtool: Split srst/erst add checks
hxtool: Error on missing docs
Markus Armbruster (1):
hmp-commands-info.hx: Move definition of "info accel"
hmp-commands-info.hx | 33 +++++++++++++--------------------
hmp-commands.hx | 27 +++++++++++++++++----------
scripts/hxtool | 38 +++++++++++++++++++++++++++++++++++---
3 files changed, 65 insertions(+), 33 deletions(-)
--
2.52.0
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 1/4] hmp-commands-info.hx: Move definition of "info accel"
2026-01-15 2:04 [PATCH 0/4] HMP: hxtool sanity checks dave
@ 2026-01-15 2:04 ` dave
2026-01-15 2:04 ` [PATCH 2/4] hmp*hx: Move info docs dave
` (3 subsequent siblings)
4 siblings, 0 replies; 12+ messages in thread
From: dave @ 2026-01-15 2:04 UTC (permalink / raw)
To: dave, armbru, berrange; +Cc: qemu-devel
From: Markus Armbruster <armbru@redhat.com>
Commit c10eb740108 (accel/system: Add 'info accel' on human monitor)
inserted "info accel" in the middle of "info sync-profile". Move it
behind "info sync-profile".
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: Dr. David Alan Gilbert <dave@treblig.org>
---
hmp-commands-info.hx | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
index 41674dcbe1..74c741f80e 100644
--- a/hmp-commands-info.hx
+++ b/hmp-commands-info.hx
@@ -267,18 +267,6 @@ ERST
.cmd = hmp_info_sync_profile,
},
- {
- .name = "accel",
- .args_type = "",
- .params = "",
- .help = "show accelerator statistics",
- },
-
-SRST
- ``info accel``
- Show accelerator statistics.
-ERST
-
SRST
``info sync-profile [-m|-n]`` [*max*]
Show synchronization profiling info, up to *max* entries (default: 10),
@@ -294,6 +282,18 @@ SRST
being coalesced.
ERST
+ {
+ .name = "accel",
+ .args_type = "",
+ .params = "",
+ .help = "show accelerator statistics",
+ },
+
+SRST
+ ``info accel``
+ Show accelerator statistics.
+ERST
+
{
.name = "kvm",
.args_type = "",
--
2.52.0
^ permalink raw reply related [flat|nested] 12+ messages in thread
* [PATCH 2/4] hmp*hx: Move info docs
2026-01-15 2:04 [PATCH 0/4] HMP: hxtool sanity checks dave
2026-01-15 2:04 ` [PATCH 1/4] hmp-commands-info.hx: Move definition of "info accel" dave
@ 2026-01-15 2:04 ` dave
2026-01-15 11:57 ` Markus Armbruster
2026-01-15 2:04 ` [PATCH 3/4] hxtool: Split srst/erst add checks dave
` (2 subsequent siblings)
4 siblings, 1 reply; 12+ messages in thread
From: dave @ 2026-01-15 2:04 UTC (permalink / raw)
To: dave, armbru, berrange; +Cc: qemu-devel
From: "Dr. David Alan Gilbert" <dave@treblig.org>
Move the docs for the info subcommand from the separate hx
into the top level file next to the 'info' command itself.
That makes every command in the top level file have a RST section.
Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
---
hmp-commands-info.hx | 9 +--------
hmp-commands.hx | 27 +++++++++++++++++----------
2 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
index 74c741f80e..964eed004c 100644
--- a/hmp-commands-info.hx
+++ b/hmp-commands-info.hx
@@ -8,14 +8,7 @@ HXCOMM
HXCOMM In this file, generally SRST fragments should have two extra
HXCOMM spaces of indent, so that the documentation list item for "info foo"
HXCOMM appears inside the documentation list item for the top level
-HXCOMM "info" documentation entry. The exception is the first SRST
-HXCOMM fragment that defines that top level entry.
-
-SRST
-``info`` *subcommand*
- Show various information about the system state.
-
-ERST
+HXCOMM "info" documentation entry.
{
.name = "version",
diff --git a/hmp-commands.hx b/hmp-commands.hx
index 5cc4788f12..f4a6eeda93 100644
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -1814,16 +1814,6 @@ SRST
command.
ERST
- {
- .name = "info",
- .args_type = "item:s?",
- .params = "[subcommand]",
- .help = "show various information about the system state",
- .cmd = hmp_info_help,
- .sub_table = hmp_info_cmds,
- .flags = "p",
- },
-
#if defined(CONFIG_FDT)
{
.name = "dumpdtb",
@@ -1867,3 +1857,20 @@ SRST
List event channels in the guest
ERST
#endif
+
+HXCOMM *** MUST BE LAST ENTRY **
+ {
+ .name = "info",
+ .args_type = "item:s?",
+ .params = "[subcommand]",
+ .help = "show various information about the system state",
+ .cmd = hmp_info_help,
+ .sub_table = hmp_info_cmds,
+ .flags = "p",
+ },
+
+SRST
+``info`` *subcommand*
+ Show various information about the system state.
+ERST
+HXCOMM *** MUST BE LAST ENTRY **
--
2.52.0
^ permalink raw reply related [flat|nested] 12+ messages in thread
* [PATCH 3/4] hxtool: Split srst/erst add checks
2026-01-15 2:04 [PATCH 0/4] HMP: hxtool sanity checks dave
2026-01-15 2:04 ` [PATCH 1/4] hmp-commands-info.hx: Move definition of "info accel" dave
2026-01-15 2:04 ` [PATCH 2/4] hmp*hx: Move info docs dave
@ 2026-01-15 2:04 ` dave
2026-01-15 12:11 ` Markus Armbruster
2026-01-15 2:04 ` [PATCH 4/4] hxtool: Error on missing docs dave
2026-01-15 11:15 ` [PATCH 0/4] HMP: hxtool sanity checks Marc-André Lureau
4 siblings, 1 reply; 12+ messages in thread
From: dave @ 2026-01-15 2:04 UTC (permalink / raw)
To: dave, armbru, berrange; +Cc: qemu-devel
From: "Dr. David Alan Gilbert" <dave@treblig.org>
Split the SRST/ERST case and add some checks.
This is mainly to make it easier to add some checks in following
patches.
Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
---
scripts/hxtool | 20 +++++++++++++++++---
1 file changed, 17 insertions(+), 3 deletions(-)
diff --git a/scripts/hxtool b/scripts/hxtool
index 80516b9437..ea2accef98 100755
--- a/scripts/hxtool
+++ b/scripts/hxtool
@@ -2,15 +2,29 @@
hxtoh()
{
- flag=1
+ outsiderst=1
while read -r str; do
case $str in
HXCOMM*)
;;
- SRST*|ERST*) flag=$(($flag^1))
+ SRST*)
+ if [ $outsiderst -eq 0 ]
+ then
+ echo "Error: SRST inside another RST" >&2
+ exit 1
+ fi
+ outsiderst=0
+ ;;
+ ERST*)
+ if [ $outsiderst -eq 1 ]
+ then
+ echo "Error: ERST already outside RST" >&2
+ exit 1
+ fi
+ outsiderst=1
;;
*)
- test $flag -eq 1 && printf "%s\n" "$str"
+ test $outsiderst -eq 1 && printf "%s\n" "$str"
;;
esac
done
--
2.52.0
^ permalink raw reply related [flat|nested] 12+ messages in thread
* [PATCH 4/4] hxtool: Error on missing docs
2026-01-15 2:04 [PATCH 0/4] HMP: hxtool sanity checks dave
` (2 preceding siblings ...)
2026-01-15 2:04 ` [PATCH 3/4] hxtool: Split srst/erst add checks dave
@ 2026-01-15 2:04 ` dave
2026-01-15 12:17 ` Markus Armbruster
2026-01-15 11:15 ` [PATCH 0/4] HMP: hxtool sanity checks Marc-André Lureau
4 siblings, 1 reply; 12+ messages in thread
From: dave @ 2026-01-15 2:04 UTC (permalink / raw)
To: dave, armbru, berrange; +Cc: qemu-devel
From: "Dr. David Alan Gilbert" <dave@treblig.org>
Error if a '.name' is seen after another '.name' without an intervening
SRST, this normally indicates missing or misplaced docs.
We can't check DEF (as used in command line options) because those
often have multiple DEF per doc.
Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
---
scripts/hxtool | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/scripts/hxtool b/scripts/hxtool
index ea2accef98..f310071daa 100755
--- a/scripts/hxtool
+++ b/scripts/hxtool
@@ -1,8 +1,14 @@
#!/bin/sh
+printifnotrst()
+{
+ test $outsiderst -eq 1 && printf "%s\n" "$str"
+}
hxtoh()
{
outsiderst=1
+ # .name for HMP
+ seenname=0
while read -r str; do
case $str in
HXCOMM*)
@@ -13,6 +19,8 @@ hxtoh()
echo "Error: SRST inside another RST" >&2
exit 1
fi
+ # consume the name
+ seenname=0
outsiderst=0
;;
ERST*)
@@ -23,8 +31,18 @@ hxtoh()
fi
outsiderst=1
;;
+ # Note the space at the start - we need to exclude something.name
+ .name*)
+ if [ $seenname -eq 1 ]
+ then
+ echo "Error: Seen another .name, maybe missing docs?" >&2
+ exit 1
+ fi
+ seenname=1
+ printifnotrst
+ ;;
*)
- test $outsiderst -eq 1 && printf "%s\n" "$str"
+ printifnotrst
;;
esac
done
--
2.52.0
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: [PATCH 0/4] HMP: hxtool sanity checks
2026-01-15 2:04 [PATCH 0/4] HMP: hxtool sanity checks dave
` (3 preceding siblings ...)
2026-01-15 2:04 ` [PATCH 4/4] hxtool: Error on missing docs dave
@ 2026-01-15 11:15 ` Marc-André Lureau
4 siblings, 0 replies; 12+ messages in thread
From: Marc-André Lureau @ 2026-01-15 11:15 UTC (permalink / raw)
To: dave; +Cc: armbru, berrange, qemu-devel
Hi
On Thu, Jan 15, 2026 at 6:05 AM <dave@treblig.org> wrote:
>
> From: "Dr. David Alan Gilbert" <dave@treblig.org>
>
> Hi,
> This adds a couple of sanity checks to hxtool to try and catch the
> type of mistake that Markus' patch fixes.
> (Included Markus' patch since otherwise the script correctly fails)
>
> Dave
>
> Dr. David Alan Gilbert (3):
> hmp*hx: Move info docs
> hxtool: Split srst/erst add checks
> hxtool: Error on missing docs
>
> Markus Armbruster (1):
> hmp-commands-info.hx: Move definition of "info accel"
>
> hmp-commands-info.hx | 33 +++++++++++++--------------------
> hmp-commands.hx | 27 +++++++++++++++++----------
> scripts/hxtool | 38 +++++++++++++++++++++++++++++++++++---
> 3 files changed, 65 insertions(+), 33 deletions(-)
>
> --
> 2.52.0
>
>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
--
Marc-André Lureau
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 2/4] hmp*hx: Move info docs
2026-01-15 2:04 ` [PATCH 2/4] hmp*hx: Move info docs dave
@ 2026-01-15 11:57 ` Markus Armbruster
2026-01-15 18:42 ` Dr. David Alan Gilbert
0 siblings, 1 reply; 12+ messages in thread
From: Markus Armbruster @ 2026-01-15 11:57 UTC (permalink / raw)
To: dave; +Cc: berrange, qemu-devel
dave@treblig.org writes:
> From: "Dr. David Alan Gilbert" <dave@treblig.org>
>
> Move the docs for the info subcommand from the separate hx
> into the top level file next to the 'info' command itself.
> That makes every command in the top level file have a RST section.
>
> Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
Generated HTML changes slightly, diff appended. Shows as vertical space
differences in Firefox. Do we care?
--- bld-docs/docs.old/manual/system/monitor.html 2026-01-15 12:30:17.300968723 +0100
+++ bld-docs/docs/manual/system/monitor.html 2026-01-15 12:55:43.909694634 +0100
@@ -601,10 +601,11 @@ command.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">xen-event-list</span></code></dt><dd><p>List event channels in the guest</p>
</dd>
-</dl>
-<dl>
<dt><code class="docutils literal notranslate"><span class="pre">info</span></code> <em>subcommand</em></dt><dd><p>Show various information about the system state.</p>
-<dl>
+</dd>
+</dl>
+<blockquote>
+<div><dl>
<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">version</span></code></dt><dd><p>Show the version of QEMU.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">network</span></code></dt><dd><p>Show the network state.</p>
@@ -639,8 +640,6 @@ command.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">jit</span></code></dt><dd><p>Show dynamic compiler info.</p>
</dd>
-<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">accel</span></code></dt><dd><p>Show accelerator statistics.</p>
-</dd>
<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">sync-profile</span> <span class="pre">[-m|-n]</span></code> [<em>max</em>]</dt><dd><p>Show synchronization profiling info, up to <em>max</em> entries (default: 10),
sorted by total wait time.</p>
<dl class="simple">
@@ -653,6 +652,8 @@ sorted by total wait time.</p>
the “Object” field shows—enclosed in brackets—the number of objects
being coalesced.</p>
</dd>
+<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">accel</span></code></dt><dd><p>Show accelerator statistics.</p>
+</dd>
<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">kvm</span></code></dt><dd><p>Show KVM information.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">accelerators</span></code></dt><dd><p>Show which accelerators are compiled into a QEMU binary, and what accelerator
@@ -765,8 +766,7 @@ enabled) memory in bytes.</p>
<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">firmware-log</span></code></dt><dd><p>Show the firmware (ovmf) debug log.</p>
</dd>
</dl>
-</dd>
-</dl>
+</div></blockquote>
</section>
<section id="integer-expressions">
<h2>Integer expressions<a class="headerlink" href="#integer-expressions" title="Link to this heading"></a></h2>
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 3/4] hxtool: Split srst/erst add checks
2026-01-15 2:04 ` [PATCH 3/4] hxtool: Split srst/erst add checks dave
@ 2026-01-15 12:11 ` Markus Armbruster
0 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2026-01-15 12:11 UTC (permalink / raw)
To: dave; +Cc: armbru, berrange, qemu-devel
dave@treblig.org writes:
> From: "Dr. David Alan Gilbert" <dave@treblig.org>
>
> Split the SRST/ERST case and add some checks.
> This is mainly to make it easier to add some checks in following
> patches.
>
> Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
> ---
> scripts/hxtool | 20 +++++++++++++++++---
> 1 file changed, 17 insertions(+), 3 deletions(-)
>
> diff --git a/scripts/hxtool b/scripts/hxtool
> index 80516b9437..ea2accef98 100755
> --- a/scripts/hxtool
> +++ b/scripts/hxtool
> @@ -2,15 +2,29 @@
>
> hxtoh()
> {
> - flag=1
> + outsiderst=1
I parsed this "outsider st" and went "WAT? Backtrack... aha". Name it
outside_rst? in_h? Or revert sense and call it in_rst?
> while read -r str; do
> case $str in
> HXCOMM*)
> ;;
> - SRST*|ERST*) flag=$(($flag^1))
> + SRST*)
> + if [ $outsiderst -eq 0 ]
> + then
> + echo "Error: SRST inside another RST" >&2
> + exit 1
> + fi
> + outsiderst=0
> + ;;
> + ERST*)
> + if [ $outsiderst -eq 1 ]
> + then
> + echo "Error: ERST already outside RST" >&2
> + exit 1
> + fi
> + outsiderst=1
> ;;
> *)
> - test $flag -eq 1 && printf "%s\n" "$str"
> + test $outsiderst -eq 1 && printf "%s\n" "$str"
> ;;
> esac
> done
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 4/4] hxtool: Error on missing docs
2026-01-15 2:04 ` [PATCH 4/4] hxtool: Error on missing docs dave
@ 2026-01-15 12:17 ` Markus Armbruster
2026-01-15 12:43 ` Dr. David Alan Gilbert
0 siblings, 1 reply; 12+ messages in thread
From: Markus Armbruster @ 2026-01-15 12:17 UTC (permalink / raw)
To: dave; +Cc: berrange, qemu-devel
dave@treblig.org writes:
> From: "Dr. David Alan Gilbert" <dave@treblig.org>
>
> Error if a '.name' is seen after another '.name' without an intervening
> SRST, this normally indicates missing or misplaced docs.
>
> We can't check DEF (as used in command line options) because those
> often have multiple DEF per doc.
Pity.
> Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
> ---
> scripts/hxtool | 20 +++++++++++++++++++-
> 1 file changed, 19 insertions(+), 1 deletion(-)
>
> diff --git a/scripts/hxtool b/scripts/hxtool
> index ea2accef98..f310071daa 100755
> --- a/scripts/hxtool
> +++ b/scripts/hxtool
> @@ -1,8 +1,14 @@
> #!/bin/sh
>
> +printifnotrst()
print_if_not_rst()? print_h()?
> +{
> + test $outsiderst -eq 1 && printf "%s\n" "$str"
> +}
> hxtoh()
> {
> outsiderst=1
> + # .name for HMP
> + seenname=0
I'd prefer seen_name.
> while read -r str; do
> case $str in
> HXCOMM*)
> @@ -13,6 +19,8 @@ hxtoh()
> echo "Error: SRST inside another RST" >&2
> exit 1
> fi
> + # consume the name
> + seenname=0
> outsiderst=0
> ;;
> ERST*)
> @@ -23,8 +31,18 @@ hxtoh()
> fi
> outsiderst=1
> ;;
> + # Note the space at the start - we need to exclude something.name
> + .name*)
This works?!? It does in my testing. I'm amazed.
> + if [ $seenname -eq 1 ]
> + then
> + echo "Error: Seen another .name, maybe missing docs?" >&2
> + exit 1
> + fi
> + seenname=1
> + printifnotrst
> + ;;
> *)
> - test $outsiderst -eq 1 && printf "%s\n" "$str"
> + printifnotrst
> ;;
> esac
> done
Could move the printing behind the case, and continue the loop in the
case SRST* and ERST*. No need for the function then. Matter of taste,
up to you.
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 4/4] hxtool: Error on missing docs
2026-01-15 12:17 ` Markus Armbruster
@ 2026-01-15 12:43 ` Dr. David Alan Gilbert
0 siblings, 0 replies; 12+ messages in thread
From: Dr. David Alan Gilbert @ 2026-01-15 12:43 UTC (permalink / raw)
To: Markus Armbruster; +Cc: berrange, qemu-devel
* Markus Armbruster (armbru@redhat.com) wrote:
> dave@treblig.org writes:
>
> > From: "Dr. David Alan Gilbert" <dave@treblig.org>
> >
> > Error if a '.name' is seen after another '.name' without an intervening
> > SRST, this normally indicates missing or misplaced docs.
> >
> > We can't check DEF (as used in command line options) because those
> > often have multiple DEF per doc.
>
> Pity.
Yeh, I added the code to do it and then realised it was broken
in too many places.
> > Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
> > ---
> > scripts/hxtool | 20 +++++++++++++++++++-
> > 1 file changed, 19 insertions(+), 1 deletion(-)
> >
> > diff --git a/scripts/hxtool b/scripts/hxtool
> > index ea2accef98..f310071daa 100755
> > --- a/scripts/hxtool
> > +++ b/scripts/hxtool
> > @@ -1,8 +1,14 @@
> > #!/bin/sh
> >
> > +printifnotrst()
>
> print_if_not_rst()? print_h()?
OK, I'll add the _'s and renames as suggested in the others as well
> > +{
> > + test $outsiderst -eq 1 && printf "%s\n" "$str"
> > +}
> > hxtoh()
> > {
> > outsiderst=1
> > + # .name for HMP
> > + seenname=0
>
> I'd prefer seen_name.
>
> > while read -r str; do
> > case $str in
> > HXCOMM*)
> > @@ -13,6 +19,8 @@ hxtoh()
> > echo "Error: SRST inside another RST" >&2
> > exit 1
> > fi
> > + # consume the name
> > + seenname=0
> > outsiderst=0
> > ;;
> > ERST*)
> > @@ -23,8 +31,18 @@ hxtoh()
> > fi
> > outsiderst=1
> > ;;
> > + # Note the space at the start - we need to exclude something.name
> > + .name*)
>
> This works?!? It does in my testing. I'm amazed.
To my amazement as well, but I couldn't find a clearer way of writing that also
worked.
> > + if [ $seenname -eq 1 ]
> > + then
> > + echo "Error: Seen another .name, maybe missing docs?" >&2
> > + exit 1
> > + fi
> > + seenname=1
> > + printifnotrst
> > + ;;
> > *)
> > - test $outsiderst -eq 1 && printf "%s\n" "$str"
> > + printifnotrst
> > ;;
> > esac
> > done
>
> Could move the printing behind the case, and continue the loop in the
> case SRST* and ERST*. No need for the function then. Matter of taste,
> up to you.
Yeh I prefer the function than clever continues and stuff.
Dave
--
-----Open up your eyes, open up your mind, open up your code -------
/ Dr. David Alan Gilbert | Running GNU/Linux | Happy \
\ dave @ treblig.org | | In Hex /
\ _________________________|_____ http://www.treblig.org |_______/
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 2/4] hmp*hx: Move info docs
2026-01-15 11:57 ` Markus Armbruster
@ 2026-01-15 18:42 ` Dr. David Alan Gilbert
2026-01-16 8:45 ` Markus Armbruster
0 siblings, 1 reply; 12+ messages in thread
From: Dr. David Alan Gilbert @ 2026-01-15 18:42 UTC (permalink / raw)
To: Markus Armbruster; +Cc: berrange, qemu-devel
* Markus Armbruster (armbru@redhat.com) wrote:
> dave@treblig.org writes:
>
> > From: "Dr. David Alan Gilbert" <dave@treblig.org>
> >
> > Move the docs for the info subcommand from the separate hx
> > into the top level file next to the 'info' command itself.
> > That makes every command in the top level file have a RST section.
> >
> > Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
>
> Generated HTML changes slightly, diff appended. Shows as vertical space
> differences in Firefox. Do we care?
It looked OK to me in Firefox, is there a bit that looks wrong/bad to you?
Dave
>
> --- bld-docs/docs.old/manual/system/monitor.html 2026-01-15 12:30:17.300968723 +0100
> +++ bld-docs/docs/manual/system/monitor.html 2026-01-15 12:55:43.909694634 +0100
> @@ -601,10 +601,11 @@ command.</p>
> </dd>
> <dt><code class="docutils literal notranslate"><span class="pre">xen-event-list</span></code></dt><dd><p>List event channels in the guest</p>
> </dd>
> -</dl>
> -<dl>
> <dt><code class="docutils literal notranslate"><span class="pre">info</span></code> <em>subcommand</em></dt><dd><p>Show various information about the system state.</p>
> -<dl>
> +</dd>
> +</dl>
> +<blockquote>
> +<div><dl>
> <dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">version</span></code></dt><dd><p>Show the version of QEMU.</p>
> </dd>
> <dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">network</span></code></dt><dd><p>Show the network state.</p>
> @@ -639,8 +640,6 @@ command.</p>
> </dd>
> <dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">jit</span></code></dt><dd><p>Show dynamic compiler info.</p>
> </dd>
> -<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">accel</span></code></dt><dd><p>Show accelerator statistics.</p>
> -</dd>
> <dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">sync-profile</span> <span class="pre">[-m|-n]</span></code> [<em>max</em>]</dt><dd><p>Show synchronization profiling info, up to <em>max</em> entries (default: 10),
> sorted by total wait time.</p>
> <dl class="simple">
> @@ -653,6 +652,8 @@ sorted by total wait time.</p>
> the “Object” field shows—enclosed in brackets—the number of objects
> being coalesced.</p>
> </dd>
> +<dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">accel</span></code></dt><dd><p>Show accelerator statistics.</p>
> +</dd>
> <dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">kvm</span></code></dt><dd><p>Show KVM information.</p>
> </dd>
> <dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">accelerators</span></code></dt><dd><p>Show which accelerators are compiled into a QEMU binary, and what accelerator
> @@ -765,8 +766,7 @@ enabled) memory in bytes.</p>
> <dt><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">firmware-log</span></code></dt><dd><p>Show the firmware (ovmf) debug log.</p>
> </dd>
> </dl>
> -</dd>
> -</dl>
> +</div></blockquote>
> </section>
> <section id="integer-expressions">
> <h2>Integer expressions<a class="headerlink" href="#integer-expressions" title="Link to this heading"></a></h2>
>
--
-----Open up your eyes, open up your mind, open up your code -------
/ Dr. David Alan Gilbert | Running GNU/Linux | Happy \
\ dave @ treblig.org | | In Hex /
\ _________________________|_____ http://www.treblig.org |_______/
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 2/4] hmp*hx: Move info docs
2026-01-15 18:42 ` Dr. David Alan Gilbert
@ 2026-01-16 8:45 ` Markus Armbruster
0 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2026-01-16 8:45 UTC (permalink / raw)
To: Dr. David Alan Gilbert; +Cc: berrange, qemu-devel
"Dr. David Alan Gilbert" <dave@treblig.org> writes:
> * Markus Armbruster (armbru@redhat.com) wrote:
>> dave@treblig.org writes:
>>
>> > From: "Dr. David Alan Gilbert" <dave@treblig.org>
>> >
>> > Move the docs for the info subcommand from the separate hx
>> > into the top level file next to the 'info' command itself.
>> > That makes every command in the top level file have a RST section.
>> >
>> > Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
>>
>> Generated HTML changes slightly, diff appended. Shows as vertical space
>> differences in Firefox. Do we care?
>
> It looked OK to me in Firefox, is there a bit that looks wrong/bad to you?
The vertical spacing around "info subcommand" changes.
Old: extra space between "xen-event-list" and "info subcommand" compared
to between other commands.
New: extra space between "info subcommand"'s doc text and "info
version".
Hypothesis: the extra space is at the boundary between hmp-commands.hx
and hmp-commands-info.hx.
I dislike the old extra space a bit less, but no big deal either way.
[...]
^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2026-01-16 8:53 UTC | newest]
Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-01-15 2:04 [PATCH 0/4] HMP: hxtool sanity checks dave
2026-01-15 2:04 ` [PATCH 1/4] hmp-commands-info.hx: Move definition of "info accel" dave
2026-01-15 2:04 ` [PATCH 2/4] hmp*hx: Move info docs dave
2026-01-15 11:57 ` Markus Armbruster
2026-01-15 18:42 ` Dr. David Alan Gilbert
2026-01-16 8:45 ` Markus Armbruster
2026-01-15 2:04 ` [PATCH 3/4] hxtool: Split srst/erst add checks dave
2026-01-15 12:11 ` Markus Armbruster
2026-01-15 2:04 ` [PATCH 4/4] hxtool: Error on missing docs dave
2026-01-15 12:17 ` Markus Armbruster
2026-01-15 12:43 ` Dr. David Alan Gilbert
2026-01-15 11:15 ` [PATCH 0/4] HMP: hxtool sanity checks Marc-André Lureau
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.