Re: [Qemu-devel] [PATCH v3 12/12] qga: start a man page

["Denis V. Lunev" <den-lists@parallels.com>]

On 08/26/2015 01:05 PM, marcandre.lureau@redhat.com wrote:
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
>
> Add a simple man page for the qemu agent.
>
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> Reviewed-by: Michael Roth <mdroth@linux.vnet.ibm.com>
> ---
>   Makefile      |  14 +++++-
>   qemu-doc.texi |   6 +++
>   qemu-ga.texi  | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>   3 files changed, 154 insertions(+), 2 deletions(-)
>   create mode 100644 qemu-ga.texi
>
> diff --git a/Makefile b/Makefile
> index 340d9c8..67d44b8 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -88,7 +88,8 @@ LIBS+=-lz $(LIBS_TOOLS)
>   HELPERS-$(CONFIG_LINUX) = qemu-bridge-helper$(EXESUF)
>   
>   ifdef BUILD_DOCS
> -DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 qmp-commands.txt
> +DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8
> +DOCS+=qmp-commands.txt
>   ifdef CONFIG_LINUX
>   DOCS+=kvm_stat.1
>   endif
> @@ -400,6 +401,9 @@ ifneq ($(TOOLS),)
>   	$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8"
>   	$(INSTALL_DATA) qemu-nbd.8 "$(DESTDIR)$(mandir)/man8"
>   endif
> +ifneq (,$(findstring qemu-ga,$(TOOLS)))
> +	$(INSTALL_DATA) qemu-ga.8 "$(DESTDIR)$(mandir)/man8"
> +endif
>   endif
>   ifdef CONFIG_VIRTFS
>   	$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
> @@ -538,6 +542,12 @@ qemu-nbd.8: qemu-nbd.texi
>   	  $(POD2MAN) --section=8 --center=" " --release=" " qemu-nbd.pod > $@, \
>   	  "  GEN   $@")
>   
> +qemu-ga.8: qemu-ga.texi
> +	$(call quiet-command, \
> +	  perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< qemu-ga.pod && \
> +	  $(POD2MAN) --section=8 --center=" " --release=" " qemu-ga.pod > $@, \
> +	  "  GEN   $@")
> +
>   kvm_stat.1: scripts/kvm/kvm_stat.texi
>   	$(call quiet-command, \
>   	  perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< kvm_stat.pod && \
> @@ -551,7 +561,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-img-cmds.texi qemu-ga.texi
>   
>   ifdef CONFIG_WIN32
>   
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index 94af8c0..84d17d1 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -412,6 +412,7 @@ snapshots.
>   * vm_snapshots::              VM snapshots
>   * qemu_img_invocation::       qemu-img Invocation
>   * qemu_nbd_invocation::       qemu-nbd Invocation
> +* qemu_ga_invocation::        qemu-ga Invocation
>   * disk_images_formats::       Disk image file formats
>   * host_drives::               Using host drives
>   * disk_images_fat_images::    Virtual FAT disk images
> @@ -505,6 +506,11 @@ state is not saved or restored properly (in particular USB).
>   
>   @include qemu-nbd.texi
>   
> +@node qemu_ga_invocation
> +@subsection @code{qemu-ga} Invocation
> +
> +@include qemu-ga.texi
> +
>   @node disk_images_formats
>   @subsection Disk image file formats
>   
> diff --git a/qemu-ga.texi b/qemu-ga.texi
> new file mode 100644
> index 0000000..7d4a628
> --- /dev/null
> +++ b/qemu-ga.texi
> @@ -0,0 +1,136 @@
> +@example
> +@c man begin SYNOPSIS
> +usage: qemu-ga [-m <method> -p <path>] [OPTION]...
> +@c man end
> +@end example
> +
> +@c man begin DESCRIPTION
> +
> +The QEMU Guest Agent is a deamon that allows the host to perform
> +various operations in the guest, such as:
s/deamon/daemon/


Guys, I am not a native speaker and it would be fine if
somebody will pay attention for the text.