monitor: added generation of documentation for hmp-commands-info.hx

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.

From the build point of view all documentation is saved into
qemu-monitor-info.texi which from now on is used for all user
documentation building.

Signed-off-by: Pavel Butsykin <pbutsykin@virtuozzo.com>
Signed-off-by: Denis V. Lunev <den@openvz.org>
CC: Paolo Bonzini <pbonzini@redhat.com>
CC: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <1441899541-1856-5-git-send-email-den@openvz.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
This commit is contained in:
Pavel Butsykin 2015-09-10 18:39:01 +03:00 committed by Paolo Bonzini
parent 70703344de
commit 2cd8af2d44
5 changed files with 18 additions and 126 deletions

1
.gitignore vendored
View File

@ -49,6 +49,7 @@
/qemu-ga /qemu-ga
/qemu-bridge-helper /qemu-bridge-helper
/qemu-monitor.texi /qemu-monitor.texi
/qemu-monitor-info.texi
/qmp-commands.txt /qmp-commands.txt
/vscclient /vscclient
/fsdev/virtfs-proxy-helper /fsdev/virtfs-proxy-helper

View File

@ -344,7 +344,7 @@ qemu-%.tar.bz2:
$(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)" $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
distclean: clean 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 config-all-devices.mak config-all-disas.mak config.status
rm -f po/*.mo tests/qemu-iotests/common.env rm -f po/*.mo tests/qemu-iotests/common.env
rm -f roms/seabios/config.mak roms/vgabios/config.mak rm -f roms/seabios/config.mak roms/vgabios/config.mak
@ -511,13 +511,16 @@ qemu-options.texi: $(SRC_PATH)/qemu-options.hx
qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@," GEN $@") $(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 qmp-commands.txt: $(SRC_PATH)/qmp-commands.hx
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -q < $< > $@," GEN $@") $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -q < $< > $@," GEN $@")
qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@," GEN $@") $(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, \ $(call quiet-command, \
perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< qemu.pod && \ perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< qemu.pod && \
$(POD2MAN) --section=1 --center=" " --release=" " qemu.pod > $@, \ $(POD2MAN) --section=1 --center=" " --release=" " qemu.pod > $@, \
@ -560,7 +563,8 @@ pdf: qemu-doc.pdf qemu-tech.pdf
qemu-doc.dvi qemu-doc.html qemu-doc.info qemu-doc.pdf: \ qemu-doc.dvi qemu-doc.html qemu-doc.info qemu-doc.pdf: \
qemu-img.texi qemu-nbd.texi qemu-options.texi \ qemu-img.texi qemu-nbd.texi qemu-options.texi \
qemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi qemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi \
qemu-monitor-info.texi
ifdef CONFIG_WIN32 ifdef CONFIG_WIN32

View File

@ -7,6 +7,10 @@ HXCOMM HXCOMM can be used for comments, discarded from both texi and C
STEXI STEXI
@table @option @table @option
@item info @var{subcommand}
@findex info
Show various information about the system state.
@table @option
ETEXI ETEXI
{ {
@ -739,3 +743,7 @@ ETEXI
STEXI STEXI
@end table @end table
ETEXI ETEXI
STEXI
@end table
ETEXI

View File

@ -1723,129 +1723,6 @@ ETEXI
.sub_table = info_cmds, .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
@item info skeys
Display the value of a storage key (s390 only)
@item info iothreads
show iothreads
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
STEXI STEXI
@end table @end table
ETEXI ETEXI

View File

@ -391,6 +391,8 @@ The following commands are available:
@include qemu-monitor.texi @include qemu-monitor.texi
@include qemu-monitor-info.texi
@subsection Integer expressions @subsection Integer expressions
The monitor understands integers expressions for every integer The monitor understands integers expressions for every integer