iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

perf_counter tools: add help texts

Browse Source 
Add Documentation/perf-stat.txt and Documentation/perf-top.txt.

The template that was used for it: Documentation/git-add.txt from Git.

Fix up small bugs to make these help texts show up both in the 'perf'
common-command summary output screen, and on the individual help screens.

Signed-off-by: Ingo Molnar <mingo@elte.hu>
This commit is contained in:
Ingo Molnar 2009-04-20 15:52:29 +02:00
parent ddcacfa0fe
commit 1d8c8b209e
4 changed files with 143 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
Documentation/perf_counter/Documentation/perf-stat.txt Normal file
View File

@ -0,0 +1,76 @@
perf-stat(1)
==========
NAME
----
perf-stat - Run a command and gather performance counter statistics
SYNOPSIS
--------
[verse]
'perf stat' [-e <EVENT> | --event=EVENT] [-l] [-a] <command>
DESCRIPTION
-----------
This command runs a command and gathers performance counter statistics
from it.
OPTIONS
-------
<command>...::
Any command you can specify in a shell.
-e::
--event=::
0:0: cpu-cycles
0:0: cycles
0:1: instructions
0:2: cache-references
0:3: cache-misses
0:4: branch-instructions
0:4: branches
0:5: branch-misses
0:6: bus-cycles
1:0: cpu-clock
1:1: task-clock
1:2: page-faults
1:2: faults
1:5: minor-faults
1:6: major-faults
1:3: context-switches
1:3: cs
1:4: cpu-migrations
1:4: migrations
rNNN: raw PMU events (eventsel+umask)
-a::
system-wide collection
-l::
scale counter values
Configuration
-------------
EXAMPLES
--------
$ perf stat sleep 1
Performance counter stats for 'sleep':
0.678356 task clock ticks (msecs)
7 context switches (events)
4 CPU migrations (events)
232 pagefaults (events)
1810403 CPU cycles (events)
946759 instructions (events)
18952 cache references (events)
4885 cache misses (events)
Wall-clock time elapsed: 1001.252894 msecs
SEE ALSO
--------
linkperf:git-tops[1]

61
Documentation/perf_counter/Documentation/perf-top.txt Normal file
View File

@ -0,0 +1,61 @@
perf-top(1)
==========
NAME
----
perf-top - Run a command and profile it
SYNOPSIS
--------
[verse]
'perf top' [-e <EVENT> | --event=EVENT] [-l] [-a] <command>
DESCRIPTION
-----------
This command runs a command and gathers a performance counter profile
from it.
OPTIONS
-------
<command>...::
Any command you can specify in a shell.
-e::
--event=::
0:0: cpu-cycles
0:0: cycles
0:1: instructions
0:2: cache-references
0:3: cache-misses
0:4: branch-instructions
0:4: branches
0:5: branch-misses
0:6: bus-cycles
1:0: cpu-clock
1:1: task-clock
1:2: page-faults
1:2: faults
1:5: minor-faults
1:6: major-faults
1:3: context-switches
1:3: cs
1:4: cpu-migrations
1:4: migrations
rNNN: raw PMU events (eventsel+umask)
-a::
system-wide collection
-l::
scale counter values
Configuration
-------------
EXAMPLES
--------
SEE ALSO
--------
linkperf:git-stat[1]

4
Documentation/perf_counter/builtin.h
View File

@ -14,6 +14,6 @@ extern void prune_packed_objects(int);
extern int read_line_with_nul(char *buf, int size, FILE *file);
extern int check_pager_config(const char *cmd);
extern int cmd_top(int argc, char **argv, const char *prefix);
extern int cmd_stat(int argc, char **argv, const char *prefix);
extern int cmd_top(int argc, const char **argv, const char *prefix);
extern int cmd_stat(int argc, const char **argv, const char *prefix);
#endif

8
Documentation/perf_counter/generate-cmdlist.sh
View File

@ -9,16 +9,16 @@ struct cmdname_help
static struct cmdname_help common_cmds[] = {"
sed -n -e 's/^git-\([^ ]*\)[ ].* common.*/\1/p' command-list.txt |
sed -n -e 's/^perf-\([^ ]*\)[ ].* common.*/\1/p' command-list.txt |
sort |
while read cmd
do
sed -n '
/^NAME/,/git-'"$cmd"'/H
/^NAME/,/perf-'"$cmd"'/H
${
x
s/.*git-'"$cmd"' - \(.*\)/ {"'"$cmd"'", "\1"},/
s/.*perf-'"$cmd"' - \(.*\)/ {"'"$cmd"'", "\1"},/
p
}' "Documentation/git-$cmd.txt"
}' "Documentation/perf-$cmd.txt"
done
echo "};"