aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArnaldo Carvalho de Melo <acme@redhat.com>2010-01-18 15:59:19 -0200
committerIngo Molnar <mingo@elte.hu>2010-01-20 08:54:58 +0100
commite8d433f335d44028d41af231ef5c52fd8a9b280b (patch)
treeda9c22773dc5ffe106014ba6c14ff31b9fc23857
parentdf3ab708b787a2b35de5101452bd51d4a8ae0ded (diff)
perf archive: Add documentation
This also makes it appear on the 'perf --help' output, i.e. util/generate-cmdlist.sh now takes it into account. Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com> Cc: Frédéric Weisbecker <fweisbec@gmail.com> Cc: Mike Galbraith <efault@gmx.de> Cc: Peter Zijlstra <a.p.zijlstra@chello.nl> Cc: Paul Mackerras <paulus@samba.org> LKML-Reference: <1263837559-24168-1-git-send-email-acme@infradead.org> Signed-off-by: Ingo Molnar <mingo@elte.hu>
-rw-r--r--tools/perf/Documentation/perf-archive.txt22
-rw-r--r--tools/perf/command-list.txt2
2 files changed, 23 insertions, 1 deletions
diff --git a/tools/perf/Documentation/perf-archive.txt b/tools/perf/Documentation/perf-archive.txt
new file mode 100644
index 00000000000..fae174dc7d0
--- /dev/null
+++ b/tools/perf/Documentation/perf-archive.txt
@@ -0,0 +1,22 @@
+perf-archive(1)
+===============
+
+NAME
+----
+perf-archive - Create archive with object files with build-ids found in perf.data file
+
+SYNOPSIS
+--------
+[verse]
+'perf archive' [file]
+
+DESCRIPTION
+-----------
+This command runs runs perf-buildid-list --with-hits, and collects the files
+with the buildids found so that analisys of perf.data contents can be possible
+on another machine.
+
+
+SEE ALSO
+--------
+linkperf:perf-record[1], linkperf:perf-buildid-list[1], linkperf:perf-report[1]
diff --git a/tools/perf/command-list.txt b/tools/perf/command-list.txt
index f73d1d90f5b..cf6444dfd73 100644
--- a/tools/perf/command-list.txt
+++ b/tools/perf/command-list.txt
@@ -3,7 +3,7 @@
# command name category [deprecated] [common]
#
perf-annotate mainporcelain common
-perf-archive mainporcelain
+perf-archive mainporcelain common
perf-bench mainporcelain common
perf-buildid-list mainporcelain common
perf-diff mainporcelain common