perf archive: Add documentation
Arnaldo Carvalho de Melo [Mon, 18 Jan 2010 17:59:19 +0000 (15:59 -0200)]
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>

tools/perf/Documentation/perf-archive.txt [new file with mode: 0644]
tools/perf/command-list.txt

diff --git a/tools/perf/Documentation/perf-archive.txt b/tools/perf/Documentation/perf-archive.txt
new file mode 100644 (file)
index 0000000..fae174d
--- /dev/null
@@ -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]
index f73d1d9..cf6444d 100644 (file)
@@ -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