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

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