diff mbox

[3/3] monitor: added generation of documentation for hmp-commands-info.hx

Message ID 1439380232-20660-4-git-send-email-den@openvz.org
State New
Headers show

Commit Message

Denis V. Lunev Aug. 12, 2015, 11:50 a.m. UTC
From: Pavel Butsykin <pbutsykin@virtuozzo.com>

It will be easier if you need to add info-commands to edit
only hmp-commands-info.hx, before this had to edit monitor.c and
hmp-commands.hx

Signed-off-by: Pavel Butsykin <pbutsykin@virtuozzo.com>
Signed-off-by: Denis V. Lunev <den@openvz.org>
CC: Luiz Capitulino <lcapitulino@redhat.com>
CC: Paolo Bonzini <pbonzini@redhat.com>
CC: Peter Maydell <peter.maydell@linaro.org>
---
 .gitignore           |   1 +
 Makefile             |   9 ++--
 hmp-commands-info.hx |   4 ++
 hmp-commands.hx      | 120 ---------------------------------------------------
 qemu-doc.texi        |   2 +
 5 files changed, 13 insertions(+), 123 deletions(-)

Comments

Peter Maydell Aug. 27, 2015, 5:39 p.m. UTC | #1
On 12 August 2015 at 12:50, Denis V. Lunev <den@openvz.org> wrote:
> From: Pavel Butsykin <pbutsykin@virtuozzo.com>
>
> It will be easier if you need to add info-commands to edit
> only hmp-commands-info.hx, before this had to edit monitor.c and
> hmp-commands.hx
>
> Signed-off-by: Pavel Butsykin <pbutsykin@virtuozzo.com>
> Signed-off-by: Denis V. Lunev <den@openvz.org>
> CC: Luiz Capitulino <lcapitulino@redhat.com>
> CC: Paolo Bonzini <pbonzini@redhat.com>
> CC: Peter Maydell <peter.maydell@linaro.org>
> ---
>  .gitignore           |   1 +
>  Makefile             |   9 ++--
>  hmp-commands-info.hx |   4 ++
>  hmp-commands.hx      | 120 ---------------------------------------------------
>  qemu-doc.texi        |   2 +
>  5 files changed, 13 insertions(+), 123 deletions(-)
>
> diff --git a/.gitignore b/.gitignore
> index 61bc492..f1c881a 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -49,6 +49,7 @@
>  /qemu-ga
>  /qemu-bridge-helper
>  /qemu-monitor.texi
> +/qemu-monitor-info.texi
>  /qmp-commands.txt
>  /vscclient
>  /fsdev/virtfs-proxy-helper
> diff --git a/Makefile b/Makefile
> index 340d9c8..768422b 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -344,7 +344,7 @@ qemu-%.tar.bz2:
>         $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
>
>  distclean: clean
> -       rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.texi qemu-img-cmds.texi qemu-monitor.texi
> +       rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.texi qemu-img-cmds.texi qemu-monitor.texi qemu-monitor-info.texi
>         rm -f config-all-devices.mak config-all-disas.mak config.status
>         rm -f po/*.mo tests/qemu-iotests/common.env
>         rm -f roms/seabios/config.mak roms/vgabios/config.mak
> @@ -508,13 +508,16 @@ qemu-options.texi: $(SRC_PATH)/qemu-options.hx
>  qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx
>         $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN   $@")
>
> +qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx
> +       $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN   $@")
> +
>  qmp-commands.txt: $(SRC_PATH)/qmp-commands.hx
>         $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -q < $< > $@,"  GEN   $@")
>
>  qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx
>         $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN   $@")
>
> -qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi
> +qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi
>         $(call quiet-command, \
>           perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< qemu.pod && \
>           $(POD2MAN) --section=1 --center=" " --release=" " qemu.pod > $@, \
> @@ -551,7 +554,7 @@ pdf: qemu-doc.pdf qemu-tech.pdf
>
>  qemu-doc.dvi qemu-doc.html qemu-doc.info qemu-doc.pdf: \
>         qemu-img.texi qemu-nbd.texi qemu-options.texi \
> -       qemu-monitor.texi qemu-img-cmds.texi
> +       qemu-monitor.texi qemu-monitor-info.texi qemu-img-cmds.texi
>
>  ifdef CONFIG_WIN32
>
> diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
> index 9ccb33f..81ae9d7 100644
> --- a/hmp-commands-info.hx
> +++ b/hmp-commands-info.hx
> @@ -6,6 +6,9 @@ HXCOMM monitor info commands
>  HXCOMM HXCOMM can be used for comments, discarded from both texi and C
>
>  STEXI
> +@item info @var{subcommand}
> +@findex info
> +Show various information about the system state.
>  @table @option
>  ETEXI
>
> @@ -708,4 +711,5 @@ ETEXI
>
>  STEXI
>  @end table
> +@end table
>  ETEXI

Where does this extra "@end table" come from?

thanks
-- PMM
Pavel Aug. 28, 2015, 7 a.m. UTC | #2
On 27.08.2015 20:39, Peter Maydell wrote:
> On 12 August 2015 at 12:50, Denis V. Lunev <den@openvz.org> wrote:
>> From: Pavel Butsykin <pbutsykin@virtuozzo.com>
>>
>> It will be easier if you need to add info-commands to edit
>> only hmp-commands-info.hx, before this had to edit monitor.c and
>> hmp-commands.hx
>>
>> Signed-off-by: Pavel Butsykin <pbutsykin@virtuozzo.com>
>> Signed-off-by: Denis V. Lunev <den@openvz.org>
>> CC: Luiz Capitulino <lcapitulino@redhat.com>
>> CC: Paolo Bonzini <pbonzini@redhat.com>
>> CC: Peter Maydell <peter.maydell@linaro.org>
>> ---
>>   .gitignore           |   1 +
>>   Makefile             |   9 ++--
>>   hmp-commands-info.hx |   4 ++
>>   hmp-commands.hx      | 120 ---------------------------------------------------
>>   qemu-doc.texi        |   2 +
>>   5 files changed, 13 insertions(+), 123 deletions(-)
>>
>> diff --git a/.gitignore b/.gitignore
>> index 61bc492..f1c881a 100644
>> --- a/.gitignore
>> +++ b/.gitignore
>> @@ -49,6 +49,7 @@
>>   /qemu-ga
>>   /qemu-bridge-helper
>>   /qemu-monitor.texi
>> +/qemu-monitor-info.texi
>>   /qmp-commands.txt
>>   /vscclient
>>   /fsdev/virtfs-proxy-helper
>> diff --git a/Makefile b/Makefile
>> index 340d9c8..768422b 100644
>> --- a/Makefile
>> +++ b/Makefile
>> @@ -344,7 +344,7 @@ qemu-%.tar.bz2:
>>          $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
>>
>>   distclean: clean
>> -       rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.texi qemu-img-cmds.texi qemu-monitor.texi
>> +       rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.texi qemu-img-cmds.texi qemu-monitor.texi qemu-monitor-info.texi
>>          rm -f config-all-devices.mak config-all-disas.mak config.status
>>          rm -f po/*.mo tests/qemu-iotests/common.env
>>          rm -f roms/seabios/config.mak roms/vgabios/config.mak
>> @@ -508,13 +508,16 @@ qemu-options.texi: $(SRC_PATH)/qemu-options.hx
>>   qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx
>>          $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN   $@")
>>
>> +qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx
>> +       $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN   $@")
>> +
>>   qmp-commands.txt: $(SRC_PATH)/qmp-commands.hx
>>          $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -q < $< > $@,"  GEN   $@")
>>
>>   qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx
>>          $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN   $@")
>>
>> -qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi
>> +qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi
>>          $(call quiet-command, \
>>            perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< qemu.pod && \
>>            $(POD2MAN) --section=1 --center=" " --release=" " qemu.pod > $@, \
>> @@ -551,7 +554,7 @@ pdf: qemu-doc.pdf qemu-tech.pdf
>>
>>   qemu-doc.dvi qemu-doc.html qemu-doc.info qemu-doc.pdf: \
>>          qemu-img.texi qemu-nbd.texi qemu-options.texi \
>> -       qemu-monitor.texi qemu-img-cmds.texi
>> +       qemu-monitor.texi qemu-monitor-info.texi qemu-img-cmds.texi
>>
>>   ifdef CONFIG_WIN32
>>
>> diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
>> index 9ccb33f..81ae9d7 100644
>> --- a/hmp-commands-info.hx
>> +++ b/hmp-commands-info.hx
>> @@ -6,6 +6,9 @@ HXCOMM monitor info commands
>>   HXCOMM HXCOMM can be used for comments, discarded from both texi and C
>>
>>   STEXI
>> +@item info @var{subcommand}
>> +@findex info
>> +Show various information about the system state.
>>   @table @option
>>   ETEXI
>>
>> @@ -708,4 +711,5 @@ ETEXI
>>
>>   STEXI
>>   @end table
>> +@end table
>>   ETEXI
> Where does this extra "@end table" come from?
>
> thanks
> -- PMM
This "@end table" come from hmp-commands.hx and it's necessary to close 
tag "@subsection Commands" from qemu-doc.texi
Peter Maydell Aug. 28, 2015, 8:19 a.m. UTC | #3
On 28 August 2015 at 08:00, Pavel Butsykin <pbutsykin@odin.com> wrote:
>
>
> On 27.08.2015 20:39, Peter Maydell wrote:
>>
>> On 12 August 2015 at 12:50, Denis V. Lunev <den@openvz.org> wrote:
>>>
>>> From: Pavel Butsykin <pbutsykin@virtuozzo.com>
>>>
>>> It will be easier if you need to add info-commands to edit
>>> only hmp-commands-info.hx, before this had to edit monitor.c and
>>> hmp-commands.hx

>>> diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
>>> index 9ccb33f..81ae9d7 100644
>>> --- a/hmp-commands-info.hx
>>> +++ b/hmp-commands-info.hx
>>> @@ -6,6 +6,9 @@ HXCOMM monitor info commands
>>>   HXCOMM HXCOMM can be used for comments, discarded from both texi and C
>>>
>>>   STEXI
>>> +@item info @var{subcommand}
>>> +@findex info
>>> +Show various information about the system state.
>>>   @table @option
>>>   ETEXI
>>>
>>> @@ -708,4 +711,5 @@ ETEXI
>>>
>>>   STEXI
>>>   @end table
>>> +@end table
>>>   ETEXI
>>
>> Where does this extra "@end table" come from?
>>
>> thanks
>> -- PMM
>
> This "@end table" come from hmp-commands.hx and it's necessary to close tag
> "@subsection Commands" from qemu-doc.texi

If the tag is opened in qemu-doc.texi then I think
qemu-doc.texi ought to be responsible for closing it.

This may be related to a bug in the docs (as they are
in master) where we close the table too early and so
the 'info trace-events' and rocker related info subcommands
aren't indented properly. (Also the rocker subcommands
don't say "info $subcommand" the way the others do.)

thanks
-- PMM
Pavel Aug. 28, 2015, 2:53 p.m. UTC | #4
On 28.08.2015 11:19, Peter Maydell wrote:
> On 28 August 2015 at 08:00, Pavel Butsykin <pbutsykin@odin.com> wrote:
>>
>> On 27.08.2015 20:39, Peter Maydell wrote:
>>> On 12 August 2015 at 12:50, Denis V. Lunev <den@openvz.org> wrote:
>>>> From: Pavel Butsykin <pbutsykin@virtuozzo.com>
>>>>
>>>> It will be easier if you need to add info-commands to edit
>>>> only hmp-commands-info.hx, before this had to edit monitor.c and
>>>> hmp-commands.hx
>>>> diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
>>>> index 9ccb33f..81ae9d7 100644
>>>> --- a/hmp-commands-info.hx
>>>> +++ b/hmp-commands-info.hx
>>>> @@ -6,6 +6,9 @@ HXCOMM monitor info commands
>>>>    HXCOMM HXCOMM can be used for comments, discarded from both texi and C
>>>>
>>>>    STEXI
>>>> +@item info @var{subcommand}
>>>> +@findex info
>>>> +Show various information about the system state.
>>>>    @table @option
>>>>    ETEXI
>>>>
>>>> @@ -708,4 +711,5 @@ ETEXI
>>>>
>>>>    STEXI
>>>>    @end table
>>>> +@end table
>>>>    ETEXI
>>> Where does this extra "@end table" come from?
>>>
>>> thanks
>>> -- PMM
>> This "@end table" come from hmp-commands.hx and it's necessary to close tag
>> "@subsection Commands" from qemu-doc.texi
> If the tag is opened in qemu-doc.texi then I think
> qemu-doc.texi ought to be responsible for closing it.
>
> This may be related to a bug in the docs (as they are
> in master) where we close the table too early and so
> the 'info trace-events' and rocker related info subcommands
> aren't indented properly. (Also the rocker subcommands
> don't say "info $subcommand" the way the others do.)
>
> thanks
> -- PMM
You're right, the "@subsection Commands" is not required to close :) 
I'll fix it, thanks.
diff mbox

Patch

diff --git a/.gitignore b/.gitignore
index 61bc492..f1c881a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -49,6 +49,7 @@ 
 /qemu-ga
 /qemu-bridge-helper
 /qemu-monitor.texi
+/qemu-monitor-info.texi
 /qmp-commands.txt
 /vscclient
 /fsdev/virtfs-proxy-helper
diff --git a/Makefile b/Makefile
index 340d9c8..768422b 100644
--- a/Makefile
+++ b/Makefile
@@ -344,7 +344,7 @@  qemu-%.tar.bz2:
 	$(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
 
 distclean: clean
-	rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.texi qemu-img-cmds.texi qemu-monitor.texi
+	rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.texi qemu-img-cmds.texi qemu-monitor.texi qemu-monitor-info.texi
 	rm -f config-all-devices.mak config-all-disas.mak config.status
 	rm -f po/*.mo tests/qemu-iotests/common.env
 	rm -f roms/seabios/config.mak roms/vgabios/config.mak
@@ -508,13 +508,16 @@  qemu-options.texi: $(SRC_PATH)/qemu-options.hx
 qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx
 	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN   $@")
 
+qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx
+	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN   $@")
+
 qmp-commands.txt: $(SRC_PATH)/qmp-commands.hx
 	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -q < $< > $@,"  GEN   $@")
 
 qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx
 	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN   $@")
 
-qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi
+qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi
 	$(call quiet-command, \
 	  perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< qemu.pod && \
 	  $(POD2MAN) --section=1 --center=" " --release=" " qemu.pod > $@, \
@@ -551,7 +554,7 @@  pdf: qemu-doc.pdf qemu-tech.pdf
 
 qemu-doc.dvi qemu-doc.html qemu-doc.info qemu-doc.pdf: \
 	qemu-img.texi qemu-nbd.texi qemu-options.texi \
-	qemu-monitor.texi qemu-img-cmds.texi
+	qemu-monitor.texi qemu-monitor-info.texi qemu-img-cmds.texi
 
 ifdef CONFIG_WIN32
 
diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
index 9ccb33f..81ae9d7 100644
--- a/hmp-commands-info.hx
+++ b/hmp-commands-info.hx
@@ -6,6 +6,9 @@  HXCOMM monitor info commands
 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
 
 STEXI
+@item info @var{subcommand}
+@findex info
+Show various information about the system state.
 @table @option
 ETEXI
 
@@ -708,4 +711,5 @@  ETEXI
 
 STEXI
 @end table
+@end table
 ETEXI
diff --git a/hmp-commands.hx b/hmp-commands.hx
index d3b7932..3b36db4 100644
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -1705,123 +1705,3 @@  ETEXI
         .mhandler.cmd = hmp_info_help,
         .sub_table = info_cmds,
     },
-
-STEXI
-@item info @var{subcommand}
-@findex info
-Show various information about the system state.
-
-@table @option
-@item info version
-show the version of QEMU
-@item info network
-show the various VLANs and the associated devices
-@item info chardev
-show the character devices
-@item info block
-show the block devices
-@item info blockstats
-show block device statistics
-@item info registers
-show the cpu registers
-@item info cpus
-show infos for each CPU
-@item info history
-show the command line history
-@item info irq
-show the interrupts statistics (if available)
-@item info pic
-show i8259 (PIC) state
-@item info pci
-show emulated PCI device info
-@item info tlb
-show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
-@item info mem
-show the active virtual memory mappings (i386 only)
-@item info jit
-show dynamic compiler info
-@item info numa
-show NUMA information
-@item info kvm
-show KVM information
-@item info usb
-show USB devices plugged on the virtual USB hub
-@item info usbhost
-show all USB host devices
-@item info profile
-show profiling information
-@item info capture
-show information about active capturing
-@item info snapshots
-show list of VM snapshots
-@item info status
-show the current VM status (running|paused)
-@item info mice
-show which guest mouse is receiving events
-@item info vnc
-show the vnc server status
-@item info name
-show the current VM name
-@item info uuid
-show the current VM UUID
-@item info cpustats
-show CPU statistics
-@item info usernet
-show user network stack connection states
-@item info migrate
-show migration status
-@item info migrate_capabilities
-show current migration capabilities
-@item info migrate_parameters
-show current migration parameters
-@item info migrate_cache_size
-show current migration XBZRLE cache size
-@item info balloon
-show balloon information
-@item info qtree
-show device tree
-@item info qdm
-show qdev device model list
-@item info qom-tree
-show object composition tree
-@item info roms
-show roms
-@item info tpm
-show the TPM device
-@item info memory-devices
-show the memory devices
-@end table
-ETEXI
-
-STEXI
-@item info trace-events
-show available trace events and their state
-ETEXI
-
-STEXI
-@item rocker @var{name}
-@findex rocker
-Show Rocker(s)
-ETEXI
-
-STEXI
-@item rocker_ports @var{name}
-@findex rocker_ports
-Show Rocker ports
-ETEXI
-
-STEXI
-@item rocker_of_dpa_flows @var{name} [@var{tbl_id}]
-@findex rocker_of_dpa_flows
-Show Rocker OF-DPA flow tables
-ETEXI
-
-STEXI
-@item rocker_of_dpa_groups @var{name} [@var{type}]
-@findex rocker_of_dpa_groups
-Show Rocker OF-DPA groups
-ETEXI
-
-STEXI
-@end table
-ETEXI
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 94af8c0..be81687 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -391,6 +391,8 @@  The following commands are available:
 
 @include qemu-monitor.texi
 
+@include qemu-monitor-info.texi
+
 @subsection Integer expressions
 
 The monitor understands integers expressions for every integer