trace-cmd: Add documentation for trace-cmd hist

Signed-off-by: Steven Rostedt <rostedt@goodmis.org>

2 files changed, 53 insertions, 1 deletions

diff --git a/Documentation/trace-cmd-hist.1.txt b/Documentation/trace-cmd-hist.1.txt
new file mode 100644
index 00000000..96a5b821
--- /dev/null
+++ b/Documentation/trace-cmd-hist.1.txt
@@ -0,0 +1,50 @@
+TRACE-CMD-HIST(1)
+==================
+
+NAME
+----
+trace-cmd-hist - show histogram of events in trace.dat file
+
+SYNOPSIS
+--------
+*trace-cmd hist* ['OPTIONS']['input-file']
+
+DESCRIPTION
+-----------
+The trace-cmd(1) hist displays a histogram form from the trace.dat file.
+Instead of showing the events as they were ordered, it creates a histogram
+that can be displayed per task or for all tasks where the most common
+events appear first. It uses the function tracer and call stacks that it
+finds to try to put together a call graph of the events.
+
+OPTIONS
+-------
+*-i* 'input-file'::
+    By default, trace-cmd hist will read the file 'trace.dat'. But the *-i*
+    option open up the given 'input-file' instead. Note, the input file may
+    also be specified as the last item on the command line.
+
+*-P*::
+    To compact all events and show the call graphs by ignoring tasks
+    and different PIDs, add the *-P* to do so. Instead of showing the
+    task name, it will group all chains together and show "<all pids>".
+
+SEE ALSO
+--------
+trace-cmd(1), trace-cmd-record(1), trace-cmd-report(1), trace-cmd-start(1),
+trace-cmd-stop(1), trace-cmd-extract(1), trace-cmd-reset(1),
+trace-cmd-split(1), trace-cmd-listen(1)
+
+AUTHOR
+------
+Written by Steven Rostedt, <rostedt@goodmis.org>
+
+RESOURCES
+---------
+git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/trace-cmd.git
+
+COPYING
+-------
+Copyright \(C) 2010 Red Hat, Inc. Free use of this software is granted under
+the terms of the GNU Public License (GPL).
+
diff --git a/Documentation/trace-cmd.1.txt b/Documentation/trace-cmd.1.txt
index a34b39ba..ea7df766 100644
--- a/Documentation/trace-cmd.1.txt
+++ b/Documentation/trace-cmd.1.txt
@@ -26,6 +26,8 @@ COMMANDS
   report  - reads a trace.dat file and converts the binary data to a
             ASCII text readable format.
 
+  hist    - show a histogram of the events.
+
   options - list the plugin options that are available to *report*
 
   start   - start the tracing without recording to a trace.dat file.
@@ -62,7 +64,7 @@ Other options see the man page for the corresponding command.
 
 SEE ALSO
 --------
-trace-cmd-record(1), trace-cmd-report(1), trace-cmd-start(1),
+trace-cmd-record(1), trace-cmd-report(1), trace-cmd-hist(1), trace-cmd-start(1),
 trace-cmd-stop(1), trace-cmd-extract(1), trace-cmd-reset(1),
 trace-cmd-restore(1), trace-cmd-stack(1),
 trace-cmd-split(1), trace-cmd-list(1), trace-cmd-listen(1),