[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH 3/3] monitor: added generation of documentation
From: |
Peter Maydell |
Subject: |
Re: [Qemu-devel] [PATCH 3/3] monitor: added generation of documentation for hmp-commands-info.hx |
Date: |
Thu, 27 Aug 2015 18:39:00 +0100 |
On 12 August 2015 at 12:50, Denis V. Lunev <address@hidden> wrote:
> 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 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
> 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
Where does this extra "@end table" come from?
thanks
-- PMM
[Qemu-devel] [PATCH 1/3] hmp-commands-info: move info_cmds content out of monitor.c, Denis V. Lunev, 2015/08/12
[Qemu-devel] [PATCH 2/3] monitor: remove target-specific code from monitor.c, Denis V. Lunev, 2015/08/12