Blame SOURCES/kvm-tools-kvm_stat-document-list-of-interactive-commands.patch

4a2fec
From 2ef292f12dbc13c450bdac0ec48c293ce6a1a7fe Mon Sep 17 00:00:00 2001
4a2fec
From: David Hildenbrand <david@redhat.com>
4a2fec
Date: Tue, 17 Oct 2017 19:15:34 +0200
4a2fec
Subject: [PATCH 29/69] tools/kvm_stat: document list of interactive commands
4a2fec
MIME-Version: 1.0
4a2fec
Content-Type: text/plain; charset=UTF-8
4a2fec
Content-Transfer-Encoding: 8bit
4a2fec
4a2fec
RH-Author: David Hildenbrand <david@redhat.com>
4a2fec
Message-id: <20171017191605.2378-9-david@redhat.com>
4a2fec
Patchwork-id: 77315
4a2fec
O-Subject: [RHEL-7.5 qemu-kvm-rhev PATCH 08/39] tools/kvm_stat: document list of interactive commands
4a2fec
Bugzilla: 1497137
4a2fec
RH-Acked-by: Paolo Bonzini <pbonzini@redhat.com>
4a2fec
RH-Acked-by: Cornelia Huck <cohuck@redhat.com>
4a2fec
RH-Acked-by: Stefan Hajnoczi <stefanha@redhat.com>
4a2fec
RH-Acked-by: Thomas Huth <thuth@redhat.com>
4a2fec
4a2fec
Upstream-status: linux.git 1eaa2f9022d55a8d7249c42def8dc4b0d682e142
4a2fec
4a2fec
Convertion of documentation (for man page generation) to texi.
4a2fec
4a2fec
commit 1eaa2f9022d55a8d7249c42def8dc4b0d682e142
4a2fec
Author: Stefan Raspl <raspl@linux.vnet.ibm.com>
4a2fec
Date:   Fri Mar 10 13:40:07 2017 +0100
4a2fec
4a2fec
    tools/kvm_stat: document list of interactive commands
4a2fec
4a2fec
    Apart from the source code, there does not seem to be a place that documents
4a2fec
    the interactive capabilities of kvm_stat yet.
4a2fec
4a2fec
    Signed-off-by: Stefan Raspl <raspl@linux.vnet.ibm.com>
4a2fec
    Signed-off-by: Radim Krčmář <rkrcmar@redhat.com>
4a2fec
4a2fec
Signed-off-by: David Hildenbrand <david@redhat.com>
4a2fec
Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>
4a2fec
---
4a2fec
 scripts/kvm/kvm_stat      |  7 +++++++
4a2fec
 scripts/kvm/kvm_stat.texi | 24 ++++++++++++++++++++++++
4a2fec
 2 files changed, 31 insertions(+)
4a2fec
4a2fec
diff --git a/scripts/kvm/kvm_stat b/scripts/kvm/kvm_stat
4a2fec
index 3e60d93..aca8508 100755
4a2fec
--- a/scripts/kvm/kvm_stat
4a2fec
+++ b/scripts/kvm/kvm_stat
4a2fec
@@ -1052,6 +1052,13 @@ Requirements:
4a2fec
   CAP_SYS_ADMIN and perf events are used.
4a2fec
 - CAP_SYS_RESOURCE if the hard limit is not high enough to allow
4a2fec
   the large number of files that are possibly opened.
4a2fec
+
4a2fec
+Interactive Commands:
4a2fec
+   f     filter by regular expression
4a2fec
+   p     filter by PID
4a2fec
+   q     quit
4a2fec
+   x     toggle reporting of stats for individual child trace events
4a2fec
+Press any other key to refresh statistics immediately.
4a2fec
 """
4a2fec
 
4a2fec
     class PlainHelpFormatter(optparse.IndentedHelpFormatter):
4a2fec
diff --git a/scripts/kvm/kvm_stat.texi b/scripts/kvm/kvm_stat.texi
4a2fec
index 4faf1a6..3519cf9 100644
4a2fec
--- a/scripts/kvm/kvm_stat.texi
4a2fec
+++ b/scripts/kvm/kvm_stat.texi
4a2fec
@@ -17,8 +17,32 @@ The set of KVM kernel module trace events may be specific to the kernel version
4a2fec
 or architecture.  It is best to check the KVM kernel module source code for the
4a2fec
 meaning of events.
4a2fec
 
4a2fec
+Use batch and logging modes for scripting purposes.
4a2fec
+
4a2fec
+@section Interactive Commands
4a2fec
+
4a2fec
+While running in regular (interactive) mode, use any of the following keys:
4a2fec
+
4a2fec
+@table @key
4a2fec
+@item f
4a2fec
+@kindex f
4a2fec
+filter by regular expression
4a2fec
+@item p
4a2fec
+@kindex p
4a2fec
+filter by PID
4a2fec
+@item q
4a2fec
+@kindex q
4a2fec
+quit
4a2fec
+@item x
4a2fec
+@kindex x
4a2fec
+toggle reporting of stats for child trace events
4a2fec
+@end table
4a2fec
+
4a2fec
+Press any other key to refresh statistics immediately.
4a2fec
+
4a2fec
 @c man end
4a2fec
 
4a2fec
+
4a2fec
 @c man begin OPTIONS
4a2fec
 @table @option
4a2fec
 @item -1, --once, --batch
4a2fec
-- 
4a2fec
1.8.3.1
4a2fec