qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-devel] [PATCH 3/3] monitor: added generation of documentation for


From: Denis V. Lunev
Subject: [Qemu-devel] [PATCH 3/3] monitor: added generation of documentation for hmp-commands-info.hx
Date: Thu, 2 Jul 2015 19:18:49 +0300

From: Pavel Butsykin <address@hidden>

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 <address@hidden>
Signed-off-by: Denis V. Lunev <address@hidden>
CC: Luiz Capitulino <address@hidden>
CC: Paolo Bonzini <address@hidden>
CC: Peter Maydell <address@hidden>
---
 .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 aed0e1f..ac29efe 100644
--- a/.gitignore
+++ b/.gitignore
@@ -47,6 +47,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 c9be643..8f394f1 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
address@hidden info @var{subcommand}
address@hidden info
+Show various information about the system state.
 @table @option
 ETEXI
 
@@ -708,4 +711,5 @@ ETEXI
 
 STEXI
 @end table
address@hidden 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
address@hidden info @var{subcommand}
address@hidden info
-Show various information about the system state.
-
address@hidden @option
address@hidden info version
-show the version of QEMU
address@hidden info network
-show the various VLANs and the associated devices
address@hidden info chardev
-show the character devices
address@hidden info block
-show the block devices
address@hidden info blockstats
-show block device statistics
address@hidden info registers
-show the cpu registers
address@hidden info cpus
-show infos for each CPU
address@hidden info history
-show the command line history
address@hidden info irq
-show the interrupts statistics (if available)
address@hidden info pic
-show i8259 (PIC) state
address@hidden info pci
-show emulated PCI device info
address@hidden info tlb
-show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa 
only)
address@hidden info mem
-show the active virtual memory mappings (i386 only)
address@hidden info jit
-show dynamic compiler info
address@hidden info numa
-show NUMA information
address@hidden info kvm
-show KVM information
address@hidden info usb
-show USB devices plugged on the virtual USB hub
address@hidden info usbhost
-show all USB host devices
address@hidden info profile
-show profiling information
address@hidden info capture
-show information about active capturing
address@hidden info snapshots
-show list of VM snapshots
address@hidden info status
-show the current VM status (running|paused)
address@hidden info mice
-show which guest mouse is receiving events
address@hidden info vnc
-show the vnc server status
address@hidden info name
-show the current VM name
address@hidden info uuid
-show the current VM UUID
address@hidden info cpustats
-show CPU statistics
address@hidden info usernet
-show user network stack connection states
address@hidden info migrate
-show migration status
address@hidden info migrate_capabilities
-show current migration capabilities
address@hidden info migrate_parameters
-show current migration parameters
address@hidden info migrate_cache_size
-show current migration XBZRLE cache size
address@hidden info balloon
-show balloon information
address@hidden info qtree
-show device tree
address@hidden info qdm
-show qdev device model list
address@hidden info qom-tree
-show object composition tree
address@hidden info roms
-show roms
address@hidden info tpm
-show the TPM device
address@hidden info memory-devices
-show the memory devices
address@hidden table
-ETEXI
-
-STEXI
address@hidden info trace-events
-show available trace events and their state
-ETEXI
-
-STEXI
address@hidden rocker @var{name}
address@hidden rocker
-Show Rocker(s)
-ETEXI
-
-STEXI
address@hidden rocker_ports @var{name}
address@hidden rocker_ports
-Show Rocker ports
-ETEXI
-
-STEXI
address@hidden rocker_of_dpa_flows @var{name} address@hidden
address@hidden rocker_of_dpa_flows
-Show Rocker OF-DPA flow tables
-ETEXI
-
-STEXI
address@hidden rocker_of_dpa_groups @var{name} address@hidden
address@hidden rocker_of_dpa_groups
-Show Rocker OF-DPA groups
-ETEXI
-
-STEXI
address@hidden table
-ETEXI
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 0125bc7..29a9c5c 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -391,6 +391,8 @@ The following commands are available:
 
 @include qemu-monitor.texi
 
address@hidden qemu-monitor-info.texi
+
 @subsection Integer expressions
 
 The monitor understands integers expressions for every integer
-- 
2.1.4




reply via email to

[Prev in Thread] Current Thread [Next in Thread]