[Qemu-devel] [PULL 03/11] kvm_stat: add kvm_stat.1 man page

[Paolo Bonzini]

From: Stefan Hajnoczi <address@hidden>

Signed-off-by: Stefan Hajnoczi <address@hidden>
Reviewed-by: Ademar Reis <address@hidden>
Reviewed-by: Wei Huang <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
---
 Makefile                  |  9 ++++++++
 scripts/kvm/kvm_stat.texi | 55 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 64 insertions(+)
 create mode 100644 scripts/kvm/kvm_stat.texi

diff --git a/Makefile b/Makefile
index d92d4cd..884b59d 100644
--- a/Makefile
+++ b/Makefile
@@ -84,6 +84,9 @@ 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
+ifdef CONFIG_LINUX
+DOCS+=kvm_stat.1
+endif
 ifdef CONFIG_VIRTFS
 DOCS+=fsdev/virtfs-proxy-helper.1
 endif
@@ -490,6 +493,12 @@ qemu-nbd.8: qemu-nbd.texi
          $(POD2MAN) --section=8 --center=" " --release=" " qemu-nbd.pod > $@, \
          "  GEN   $@")
 
+kvm_stat.1: scripts/kvm/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/scripts/kvm/kvm_stat.texi b/scripts/kvm/kvm_stat.texi
new file mode 100644
index 0000000..6ce00d8
--- /dev/null
+++ b/scripts/kvm/kvm_stat.texi
@@ -0,0 +1,55 @@
address@hidden
address@hidden man begin SYNOPSIS
+usage: kvm_stat [OPTION]...
address@hidden man end
address@hidden example
+
address@hidden man begin DESCRIPTION
+
+kvm_stat prints counts of KVM kernel module trace events.  These events signify
+state transitions such as guest mode entry and exit.
+
+This tool is useful for observing guest behavior from the host perspective.
+Often conclusions about performance or buggy behavior can be drawn from the
+output.
+
+The set of KVM kernel module trace events may be specific to the kernel version
+or architecture.  It is best to check the KVM kernel module source code for the
+meaning of events.
+
+Note that trace events are counted globally across all running guests.
+
address@hidden man end
+
address@hidden man begin OPTIONS
address@hidden @option
address@hidden -1, --once, --batch
+  run in batch mode for one second
address@hidden -l, --log
+  run in logging mode (like vmstat)
address@hidden -t, --tracepoints
+  retrieve statistics from tracepoints
address@hidden -d, --debugfs
+  retrieve statistics from debugfs
address@hidden -f, address@hidden
+  fields to display (regex)
address@hidden -h, --help
+  show help message
address@hidden table
+
address@hidden man end
+
address@hidden
+
address@hidden kvm_stat
address@hidden Report KVM kernel module event counters.
+
address@hidden man begin AUTHOR
+Stefan Hajnoczi <address@hidden>
address@hidden man end
+
address@hidden man begin SEEALSO
+perf(1), trace-cmd(1)
address@hidden man end
+
address@hidden ignore
-- 
2.3.0