[Qemu-devel] [PATCH] Documentation for kvm_stat.

[Qemu-devel] [PATCH] Documentation for kvm_stat.

[Bo Yang]

Signed-off-by: Bo Yang <boyang@suse.com>
---
 Makefile      |    9 ++++++++-
 kvm_stat.texi |   55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+), 1 deletions(-)
 create mode 100644 kvm_stat.texi

diff --git a/Makefile b/Makefile
index 1cd5bc8..ee524b0 100644
--- a/Makefile
+++ b/Makefile
@@ -40,7 +40,7 @@ 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/qmp-commands.txt
+DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 kvm_stat.1 QMP/qmp-commands.txt
 ifdef CONFIG_VIRTFS
 DOCS+=fsdev/virtfs-proxy-helper.1
 endif
@@ -283,6 +283,7 @@ ifdef CONFIG_POSIX
 	$(INSTALL_DATA) qemu.1 qemu-img.1 "$(DESTDIR)$(mandir)/man1"
 	$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8"
 	$(INSTALL_DATA) qemu-nbd.8 "$(DESTDIR)$(mandir)/man8"
+	$(INSTALL_DATA) kvm_stat.1 "$(DESTDIR)$(mandir)/man1"
 endif
 ifdef CONFIG_VIRTFS
 	$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
@@ -387,6 +388,12 @@ qemu-nbd.8: qemu-nbd.texi
 	  $(POD2MAN) --section=8 --center=" " --release=" " qemu-nbd.pod > $@, \
 	  "  GEN   $@")
 
+kvm_stat.1: kvm_stat.texi
+	$(call quiet-command, \
+	  perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< kvm_stat.pod && \
+	  $(POD2MAN) --section=1 --center=" " --release=" " kvm_stat.pod > $@, \
+	  "  GEN   $@")
+
 dvi: qemu-doc.dvi qemu-tech.dvi
 html: qemu-doc.html qemu-tech.html
 info: qemu-doc.info qemu-tech.info
diff --git a/kvm_stat.texi b/kvm_stat.texi
new file mode 100644
index 0000000..ff7d414
--- /dev/null
+++ b/kvm_stat.texi
@@ -0,0 +1,55 @@
+@example
+@c man begin SYNOPSIS
+
+usage: kvm_stat [OPTIONS]
+
+@c man end
+@end example
+
+@c man begin DESCRIPTION
+
+This is a utility to watch kvm statistics.
+
+@c man end
+@c man begin OPTIONS
+
+@table @option
+
+@item -h, --help
+
+Show help message.
+
+@item -1, --once, --batch
+
+Run in batch mode for one second.
+
+@item -l, --log
+
+Run in logging mode (like vmstat).
+
+@item -f @var{FIELDS}, --fields=@var{FIELDS}
+
+Fields to display (regex). regex expression can be accepted here. Fields include:
+@samp{size}, @samp{config}, @samp{sample_freq}, @samp{sample_type}, @samp{read_format}, @samp{flags}, @samp{wakeup_events}, @samp{bp_type}, @samp{bp_addr}, @samp{bp_len}
+
+@end table
+@c man end
+
+@ignore
+
+@setfilename kvm_stat
+@settitle kvm statistics utility
+
+@c man begin SEE ALSO
+
+vmstat
+
+@c man end
+
+@c man begin AUTHOR
+
+Copyright (C) 2012 Bo Yang <boyang@suse.com>.
+This is free software; see the source for copying conditions.  There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+@c man end
+@end ignore
-- 
1.6.0.2