[Qemu-devel] [PATCH 0/2] kvm_stat: add man page and tui column headers

[Qemu-devel] [PATCH 0/2] kvm_stat: add man page and tui column headers

[Stefan Hajnoczi]

This series makes kvm_stat easier to learn for newcomers by adding a man page
and text UI column headers.

Stefan Hajnoczi (2):
  kvm_stat: add column headers to text UI
  kvm_stat: add kvm_stat.1 man page

 Makefile                  |  9 ++++++++
 scripts/kvm/kvm_stat      |  5 ++++-
 scripts/kvm/kvm_stat.texi | 55 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 scripts/kvm/kvm_stat.texi

-- 
2.1.0

[Qemu-devel] [PATCH 1/2] kvm_stat: add column headers to text UI

[Stefan Hajnoczi]

The curses user interface shows both the accumulated total and the
current event counts.  Add column headers so it's clear what the numbers
mean.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
 scripts/kvm/kvm_stat | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/scripts/kvm/kvm_stat b/scripts/kvm/kvm_stat
index c65cabd..7e5d256 100755
--- a/scripts/kvm/kvm_stat
+++ b/scripts/kvm/kvm_stat
@@ -519,7 +519,10 @@ def tui(screen, stats):
     def refresh(sleeptime):
         screen.erase()
         screen.addstr(0, 0, 'kvm statistics')
-        row = 2
+        screen.addstr(2, 1, 'Event')
+        screen.addstr(2, 1 + label_width + number_width - len('Total'), 'Total')
+        screen.addstr(2, 1 + label_width + number_width + 8 - len('Current'), 'Current')
+        row = 3
         s = stats.get()
         def sortkey(x):
             if s[x][1]:
-- 
2.1.0

[Qemu-devel] [PATCH 2/2] kvm_stat: add kvm_stat.1 man page

[Stefan Hajnoczi]

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
 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 6817c6f..509e9ad 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 @@
+@example
+@c man begin SYNOPSIS
+usage: kvm_stat [OPTION]...
+@c man end
+@end example
+
+@c 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.
+
+@c man end
+
+@c man begin OPTIONS
+@table @option
+@item -1, --once, --batch
+  run in batch mode for one second
+@item -l, --log
+  run in logging mode (like vmstat)
+@item -t, --tracepoints
+  retrieve statistics from tracepoints
+@item -d, --debugfs
+  retrieve statistics from debugfs
+@item -f, --fields=@var{fields}
+  fields to display (regex)
+@item -h, --help
+  show help message
+@end table
+
+@c man end
+
+@ignore
+
+@setfilename kvm_stat
+@settitle Report KVM kernel module event counters.
+
+@c man begin AUTHOR
+Stefan Hajnoczi <stefanha@redhat.com>
+@c man end
+
+@c man begin SEEALSO
+perf(1), trace-cmd(1)
+@c man end
+
+@end ignore
-- 
2.1.0

Re: [Qemu-devel] [PATCH 0/2] kvm_stat: add man page and tui column headers

[Ademar Reis]

On Mon, Mar 02, 2015 at 05:29:05PM -0600, Stefan Hajnoczi wrote:
> This series makes kvm_stat easier to learn for newcomers by adding a man page
> and text UI column headers.
> 
> Stefan Hajnoczi (2):
>   kvm_stat: add column headers to text UI
>   kvm_stat: add kvm_stat.1 man page
> 
>  Makefile                  |  9 ++++++++
>  scripts/kvm/kvm_stat      |  5 ++++-
>  scripts/kvm/kvm_stat.texi | 55 +++++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 68 insertions(+), 1 deletion(-)
>  create mode 100644 scripts/kvm/kvm_stat.texi
> 

Patches are close to trivial, but anyway, I reviewed and tested
them.

Reviewed-by: Ademar Reis <areis@redhat.com>

-- 
Ademar Reis
Red Hat

^[:wq!

Re: [Qemu-devel] [PATCH 0/2] kvm_stat: add man page and tui column headers

[Wei Huang]

On 03/02/2015 05:29 PM, Stefan Hajnoczi wrote:
> This series makes kvm_stat easier to learn for newcomers by adding a man page
> and text UI column headers.
> 
> Stefan Hajnoczi (2):
>   kvm_stat: add column headers to text UI
>   kvm_stat: add kvm_stat.1 man page
> 
>  Makefile                  |  9 ++++++++
>  scripts/kvm/kvm_stat      |  5 ++++-
>  scripts/kvm/kvm_stat.texi | 55 +++++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 68 insertions(+), 1 deletion(-)
>  create mode 100644 scripts/kvm/kvm_stat.texi
> 
Reviewed-by: Wei Huang <wei@redhat.com>

Thanks,
-Wei

Re: [Qemu-devel] [PATCH 0/2] kvm_stat: add man page and tui column headers

[Paolo Bonzini]

On 03/03/2015 00:29, Stefan Hajnoczi wrote:
> This series makes kvm_stat easier to learn for newcomers by adding a man page
> and text UI column headers.
> 
> Stefan Hajnoczi (2):
>   kvm_stat: add column headers to text UI
>   kvm_stat: add kvm_stat.1 man page
> 
>  Makefile                  |  9 ++++++++
>  scripts/kvm/kvm_stat      |  5 ++++-
>  scripts/kvm/kvm_stat.texi | 55 +++++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 68 insertions(+), 1 deletion(-)
>  create mode 100644 scripts/kvm/kvm_stat.texi
> 

Applied, thanks.

Paolo