[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 11/24] monitor: added generation of documentation for
From: |
Paolo Bonzini |
Subject: |
[Qemu-devel] [PULL 11/24] monitor: added generation of documentation for hmp-commands-info.hx |
Date: |
Wed, 16 Sep 2015 14:29:42 +0200 |
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.
>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 <address@hidden>
Signed-off-by: Denis V. Lunev <address@hidden>
CC: Paolo Bonzini <address@hidden>
CC: Peter Maydell <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
---
.gitignore | 1 +
Makefile | 10 +++--
hmp-commands-info.hx | 8 ++++
hmp-commands.hx | 123 ---------------------------------------------------
qemu-doc.texi | 2 +
5 files changed, 18 insertions(+), 126 deletions(-)
diff --git a/.gitignore b/.gitignore
index cb4b8ec..367bc70 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 9ce3972..c540442 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
@@ -511,13 +511,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 > $@, \
@@ -560,7 +563,8 @@ 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-ga.texi
+ qemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi \
+ qemu-monitor-info.texi
ifdef CONFIG_WIN32
diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
index 1d0906a..9f5a158 100644
--- a/hmp-commands-info.hx
+++ b/hmp-commands-info.hx
@@ -7,6 +7,10 @@ HXCOMM HXCOMM can be used for comments, discarded from both
texi and C
STEXI
@table @option
address@hidden info @var{subcommand}
address@hidden info
+Show various information about the system state.
address@hidden @option
ETEXI
{
@@ -739,3 +743,7 @@ ETEXI
STEXI
@end table
ETEXI
+
+STEXI
address@hidden table
+ETEXI
diff --git a/hmp-commands.hx b/hmp-commands.hx
index 89fc09f..a511004 100644
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -1724,128 +1724,5 @@ ETEXI
},
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 info skeys
-Display the value of a storage key (s390 only)
address@hidden info iothreads
-show iothreads
-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
-
-STEXI
@end table
ETEXI
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 7af4412..5b81aa0 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.5.0
- [Qemu-devel] [PULL 01/24] pci: remove Link Training error from AER error list, (continued)
- [Qemu-devel] [PULL 01/24] pci: remove Link Training error from AER error list, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 02/24] update Linux headers to 4.3-rc1, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 06/24] kvm: Add kvm system event crash handler, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 03/24] update-linux-headers: copy standard-headers files one by one, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 04/24] target-i386: move asm-x86/hyperv.h to standard-headers, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 05/24] cpu: Add crash_occurred flag into CPUState, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 08/24] hmp-commands-info: move info_cmds content out of monitor.c, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 07/24] i386/kvm: Hyper-v crash msrs set/get'ers and migration, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 10/24] hmp-commands.hx: fix end of table info, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 12/24] qemu-char: Use g_new() & friends where that makes obvious sense, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 11/24] monitor: added generation of documentation for hmp-commands-info.hx,
Paolo Bonzini <=
- [Qemu-devel] [PULL 13/24] cpu-exec: Migrate some generic fns to cpu-exec-common, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 14/24] translate-all: Move tcg_handle_interrupt() to -common, Paolo Bonzini, 2015/09/16
- [Qemu-devel] [PULL 16/24] tcg: Move tci_tb_ptr to -common, Paolo Bonzini, 2015/09/16
[Qemu-devel] [PULL 15/24] tcg: split tcg_op_defs to -common, Paolo Bonzini, 2015/09/16
[Qemu-devel] [PULL 09/24] monitor: remove target-specific code from monitor.c, Paolo Bonzini, 2015/09/16
[Qemu-devel] [PULL 18/24] cputlb: move CPU_LOOP() for tlb_reset() to exec.c, Paolo Bonzini, 2015/09/16