diff options
| author | Dan Williams <dan.j.williams@intel.com> | 2009-09-08 17:55:21 -0700 | 
|---|---|---|
| committer | Dan Williams <dan.j.williams@intel.com> | 2009-09-08 17:55:21 -0700 | 
| commit | bbb20089a3275a19e475dbc21320c3742e3ca423 (patch) | |
| tree | 216fdc1cbef450ca688135c5b8969169482d9a48 /tools/perf/Documentation | |
| parent | 3e48e656903e9fd8bc805c6a2c4264d7808d315b (diff) | |
| parent | 657a77fa7284d8ae28dfa48f1dc5d919bf5b2843 (diff) | |
Merge branch 'dmaengine' into async-tx-next
Conflicts:
	crypto/async_tx/async_xor.c
	drivers/dma/ioat/dma_v2.h
	drivers/dma/ioat/pci.c
	drivers/md/raid5.c
Diffstat (limited to 'tools/perf/Documentation')
| -rw-r--r-- | tools/perf/Documentation/Makefile | 300 | ||||
| -rw-r--r-- | tools/perf/Documentation/asciidoc.conf | 91 | ||||
| -rw-r--r-- | tools/perf/Documentation/manpage-1.72.xsl | 14 | ||||
| -rw-r--r-- | tools/perf/Documentation/manpage-base.xsl | 35 | ||||
| -rw-r--r-- | tools/perf/Documentation/manpage-bold-literal.xsl | 17 | ||||
| -rw-r--r-- | tools/perf/Documentation/manpage-normal.xsl | 13 | ||||
| -rw-r--r-- | tools/perf/Documentation/manpage-suppress-sp.xsl | 21 | ||||
| -rw-r--r-- | tools/perf/Documentation/perf-annotate.txt | 29 | ||||
| -rw-r--r-- | tools/perf/Documentation/perf-help.txt | 38 | ||||
| -rw-r--r-- | tools/perf/Documentation/perf-list.txt | 25 | ||||
| -rw-r--r-- | tools/perf/Documentation/perf-record.txt | 42 | ||||
| -rw-r--r-- | tools/perf/Documentation/perf-report.txt | 26 | ||||
| -rw-r--r-- | tools/perf/Documentation/perf-stat.txt | 66 | ||||
| -rw-r--r-- | tools/perf/Documentation/perf-top.txt | 39 | ||||
| -rw-r--r-- | tools/perf/Documentation/perf.txt | 24 | 
15 files changed, 780 insertions, 0 deletions
diff --git a/tools/perf/Documentation/Makefile b/tools/perf/Documentation/Makefile new file mode 100644 index 00000000000..5457192e1b4 --- /dev/null +++ b/tools/perf/Documentation/Makefile @@ -0,0 +1,300 @@ +MAN1_TXT= \ +	$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \ +		$(wildcard perf-*.txt)) \ +	perf.txt +MAN5_TXT= +MAN7_TXT= + +MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT) +MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT)) +MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT)) + +DOC_HTML=$(MAN_HTML) + +ARTICLES = +# with their own formatting rules. +SP_ARTICLES = +API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt))) +SP_ARTICLES += $(API_DOCS) +SP_ARTICLES += technical/api-index + +DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES)) + +DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT)) +DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT)) +DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT)) + +prefix?=$(HOME) +bindir?=$(prefix)/bin +htmldir?=$(prefix)/share/doc/perf-doc +pdfdir?=$(prefix)/share/doc/perf-doc +mandir?=$(prefix)/share/man +man1dir=$(mandir)/man1 +man5dir=$(mandir)/man5 +man7dir=$(mandir)/man7 +# DESTDIR= + +ASCIIDOC=asciidoc +ASCIIDOC_EXTRA = +MANPAGE_XSL = manpage-normal.xsl +XMLTO_EXTRA = +INSTALL?=install +RM ?= rm -f +DOC_REF = origin/man +HTML_REF = origin/html + +infodir?=$(prefix)/share/info +MAKEINFO=makeinfo +INSTALL_INFO=install-info +DOCBOOK2X_TEXI=docbook2x-texi +DBLATEX=dblatex +ifndef PERL_PATH +	PERL_PATH = /usr/bin/perl +endif + +-include ../config.mak.autogen +-include ../config.mak + +# +# For asciidoc ... +#	-7.1.2,	no extra settings are needed. +#	8.0-,	set ASCIIDOC8. +# + +# +# For docbook-xsl ... +#	-1.68.1,	set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0) +#	1.69.0,		no extra settings are needed? +#	1.69.1-1.71.0,	set DOCBOOK_SUPPRESS_SP? +#	1.71.1,		no extra settings are needed? +#	1.72.0,		set DOCBOOK_XSL_172. +#	1.73.0-,	set ASCIIDOC_NO_ROFF +# + +# +# If you had been using DOCBOOK_XSL_172 in an attempt to get rid +# of 'the ".ft C" problem' in your generated manpages, and you +# instead ended up with weird characters around callouts, try +# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8). +# + +ifdef ASCIIDOC8 +ASCIIDOC_EXTRA += -a asciidoc7compatible +endif +ifdef DOCBOOK_XSL_172 +ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff +MANPAGE_XSL = manpage-1.72.xsl +else +	ifdef ASCIIDOC_NO_ROFF +	# docbook-xsl after 1.72 needs the regular XSL, but will not +	# pass-thru raw roff codes from asciidoc.conf, so turn them off. +	ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff +	endif +endif +ifdef MAN_BOLD_LITERAL +XMLTO_EXTRA += -m manpage-bold-literal.xsl +endif +ifdef DOCBOOK_SUPPRESS_SP +XMLTO_EXTRA += -m manpage-suppress-sp.xsl +endif + +SHELL_PATH ?= $(SHELL) +# Shell quote; +SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH)) + +# +# Please note that there is a minor bug in asciidoc. +# The version after 6.0.3 _will_ include the patch found here: +#   http://marc.theaimsgroup.com/?l=perf&m=111558757202243&w=2 +# +# Until that version is released you may have to apply the patch +# yourself - yes, all 6 characters of it! +# + +QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir +QUIET_SUBDIR1  = + +ifneq ($(findstring $(MAKEFLAGS),w),w) +PRINT_DIR = --no-print-directory +else # "make -w" +NO_SUBDIR = : +endif + +ifneq ($(findstring $(MAKEFLAGS),s),s) +ifndef V +	QUIET_ASCIIDOC	= @echo '   ' ASCIIDOC $@; +	QUIET_XMLTO	= @echo '   ' XMLTO $@; +	QUIET_DB2TEXI	= @echo '   ' DB2TEXI $@; +	QUIET_MAKEINFO	= @echo '   ' MAKEINFO $@; +	QUIET_DBLATEX	= @echo '   ' DBLATEX $@; +	QUIET_XSLTPROC	= @echo '   ' XSLTPROC $@; +	QUIET_GEN	= @echo '   ' GEN $@; +	QUIET_STDERR	= 2> /dev/null +	QUIET_SUBDIR0	= +@subdir= +	QUIET_SUBDIR1	= ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \ +			  $(MAKE) $(PRINT_DIR) -C $$subdir +	export V +endif +endif + +all: html man + +html: $(DOC_HTML) + +$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf + +man: man1 man5 man7 +man1: $(DOC_MAN1) +man5: $(DOC_MAN5) +man7: $(DOC_MAN7) + +info: perf.info perfman.info + +pdf: user-manual.pdf + +install: install-man + +install-man: man +	$(INSTALL) -d -m 755 $(DESTDIR)$(man1dir) +#	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir) +#	$(INSTALL) -d -m 755 $(DESTDIR)$(man7dir) +	$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir) +#	$(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir) +#	$(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir) + +install-info: info +	$(INSTALL) -d -m 755 $(DESTDIR)$(infodir) +	$(INSTALL) -m 644 perf.info perfman.info $(DESTDIR)$(infodir) +	if test -r $(DESTDIR)$(infodir)/dir; then \ +	  $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perf.info ;\ +	  $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perfman.info ;\ +	else \ +	  echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \ +	fi + +install-pdf: pdf +	$(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir) +	$(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir) + +install-html: html +	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir) + +../PERF-VERSION-FILE: .FORCE-PERF-VERSION-FILE +	$(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) PERF-VERSION-FILE + +-include ../PERF-VERSION-FILE + +# +# Determine "include::" file references in asciidoc files. +# +doc.dep : $(wildcard *.txt) build-docdep.perl +	$(QUIET_GEN)$(RM) $@+ $@ && \ +	$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \ +	mv $@+ $@ + +-include doc.dep + +cmds_txt = cmds-ancillaryinterrogators.txt \ +	cmds-ancillarymanipulators.txt \ +	cmds-mainporcelain.txt \ +	cmds-plumbinginterrogators.txt \ +	cmds-plumbingmanipulators.txt \ +	cmds-synchingrepositories.txt \ +	cmds-synchelpers.txt \ +	cmds-purehelpers.txt \ +	cmds-foreignscminterface.txt + +$(cmds_txt): cmd-list.made + +cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT) +	$(QUIET_GEN)$(RM) $@ && \ +	$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \ +	date >$@ + +clean: +	$(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7 +	$(RM) *.texi *.texi+ *.texi++ perf.info perfman.info +	$(RM) howto-index.txt howto/*.html doc.dep +	$(RM) technical/api-*.html technical/api-index.txt +	$(RM) $(cmds_txt) *.made + +$(MAN_HTML): %.html : %.txt +	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ +	$(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \ +		$(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \ +	mv $@+ $@ + +%.1 %.5 %.7 : %.xml +	$(QUIET_XMLTO)$(RM) $@ && \ +	xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< + +%.xml : %.txt +	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ +	$(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \ +		$(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \ +	mv $@+ $@ + +XSLT = docbook.xsl +XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css + +user-manual.html: user-manual.xml +	$(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $< + +perf.info: user-manual.texi +	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi + +user-manual.texi: user-manual.xml +	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \ +	$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \ +	$(PERL_PATH) fix-texi.perl <$@++ >$@+ && \ +	rm $@++ && \ +	mv $@+ $@ + +user-manual.pdf: user-manual.xml +	$(QUIET_DBLATEX)$(RM) $@+ $@ && \ +	$(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \ +	mv $@+ $@ + +perfman.texi: $(MAN_XML) cat-texi.perl +	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \ +	($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \ +		--to-stdout $(xml) &&) true) > $@++ && \ +	$(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \ +	rm $@++ && \ +	mv $@+ $@ + +perfman.info: perfman.texi +	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi + +$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml +	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \ +	$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \ +	mv $@+ $@ + +howto-index.txt: howto-index.sh $(wildcard howto/*.txt) +	$(QUIET_GEN)$(RM) $@+ $@ && \ +	'$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \ +	mv $@+ $@ + +$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt +	$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 $*.txt + +WEBDOC_DEST = /pub/software/tools/perf/docs + +$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt +	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ +	sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+ && \ +	mv $@+ $@ + +install-webdoc : html +	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST) + +quick-install: quick-install-man + +quick-install-man: +	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir) + +quick-install-html: +	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir) + +.PHONY: .FORCE-PERF-VERSION-FILE diff --git a/tools/perf/Documentation/asciidoc.conf b/tools/perf/Documentation/asciidoc.conf new file mode 100644 index 00000000000..356b23a4033 --- /dev/null +++ b/tools/perf/Documentation/asciidoc.conf @@ -0,0 +1,91 @@ +## linkperf: macro +# +# Usage: linkperf:command[manpage-section] +# +# Note, {0} is the manpage section, while {target} is the command. +# +# Show PERF link as: <command>(<section>); if section is defined, else just show +# the command. + +[macros] +(?su)[\\]?(?P<name>linkperf):(?P<target>\S*?)\[(?P<attrlist>.*?)\]= + +[attributes] +asterisk=* +plus=+ +caret=^ +startsb=[ +endsb=] +tilde=~ + +ifdef::backend-docbook[] +[linkperf-inlinemacro] +{0%{target}} +{0#<citerefentry>} +{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} +{0#</citerefentry>} +endif::backend-docbook[] + +ifdef::backend-docbook[] +ifndef::perf-asciidoc-no-roff[] +# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this. +# v1.72 breaks with this because it replaces dots not in roff requests. +[listingblock] +<example><title>{title}</title> +<literallayout> +ifdef::doctype-manpage[] +
.ft C
 +endif::doctype-manpage[] +| +ifdef::doctype-manpage[] +
.ft
 +endif::doctype-manpage[] +</literallayout> +{title#}</example> +endif::perf-asciidoc-no-roff[] + +ifdef::perf-asciidoc-no-roff[] +ifdef::doctype-manpage[] +# The following two small workarounds insert a simple paragraph after screen +[listingblock] +<example><title>{title}</title> +<literallayout> +| +</literallayout><simpara></simpara> +{title#}</example> + +[verseblock] +<formalpara{id? id="{id}"}><title>{title}</title><para> +{title%}<literallayout{id? id="{id}"}> +{title#}<literallayout> +| +</literallayout> +{title#}</para></formalpara> +{title%}<simpara></simpara> +endif::doctype-manpage[] +endif::perf-asciidoc-no-roff[] +endif::backend-docbook[] + +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[header] +template::[header-declarations] +<refentry> +<refmeta> +<refentrytitle>{mantitle}</refentrytitle> +<manvolnum>{manvolnum}</manvolnum> +<refmiscinfo class="source">perf</refmiscinfo> +<refmiscinfo class="version">{perf_version}</refmiscinfo> +<refmiscinfo class="manual">perf Manual</refmiscinfo> +</refmeta> +<refnamediv> +  <refname>{manname}</refname> +  <refpurpose>{manpurpose}</refpurpose> +</refnamediv> +endif::backend-docbook[] +endif::doctype-manpage[] + +ifdef::backend-xhtml11[] +[linkperf-inlinemacro] +<a href="{target}.html">{target}{0?({0})}</a> +endif::backend-xhtml11[] diff --git a/tools/perf/Documentation/manpage-1.72.xsl b/tools/perf/Documentation/manpage-1.72.xsl new file mode 100644 index 00000000000..b4d315cb8c4 --- /dev/null +++ b/tools/perf/Documentation/manpage-1.72.xsl @@ -0,0 +1,14 @@ +<!-- manpage-1.72.xsl: +     special settings for manpages rendered from asciidoc+docbook +     handles peculiarities in docbook-xsl 1.72.0 --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" +		version="1.0"> + +<xsl:import href="manpage-base.xsl"/> + +<!-- these are the special values for the roff control characters +     needed for docbook-xsl 1.72.0 --> +<xsl:param name="git.docbook.backslash">▓</xsl:param> +<xsl:param name="git.docbook.dot"      >⌂</xsl:param> + +</xsl:stylesheet> diff --git a/tools/perf/Documentation/manpage-base.xsl b/tools/perf/Documentation/manpage-base.xsl new file mode 100644 index 00000000000..a264fa61609 --- /dev/null +++ b/tools/perf/Documentation/manpage-base.xsl @@ -0,0 +1,35 @@ +<!-- manpage-base.xsl: +     special formatting for manpages rendered from asciidoc+docbook --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" +		version="1.0"> + +<!-- these params silence some output from xmlto --> +<xsl:param name="man.output.quietly" select="1"/> +<xsl:param name="refentry.meta.get.quietly" select="1"/> + +<!-- convert asciidoc callouts to man page format; +     git.docbook.backslash and git.docbook.dot params +     must be supplied by another XSL file or other means --> +<xsl:template match="co"> +	<xsl:value-of select="concat( +			      $git.docbook.backslash,'fB(', +			      substring-after(@id,'-'),')', +			      $git.docbook.backslash,'fR')"/> +</xsl:template> +<xsl:template match="calloutlist"> +	<xsl:value-of select="$git.docbook.dot"/> +	<xsl:text>sp
</xsl:text> +	<xsl:apply-templates/> +	<xsl:text>
</xsl:text> +</xsl:template> +<xsl:template match="callout"> +	<xsl:value-of select="concat( +			      $git.docbook.backslash,'fB', +			      substring-after(@arearefs,'-'), +			      '. ',$git.docbook.backslash,'fR')"/> +	<xsl:apply-templates/> +	<xsl:value-of select="$git.docbook.dot"/> +	<xsl:text>br
</xsl:text> +</xsl:template> + +</xsl:stylesheet> diff --git a/tools/perf/Documentation/manpage-bold-literal.xsl b/tools/perf/Documentation/manpage-bold-literal.xsl new file mode 100644 index 00000000000..608eb5df628 --- /dev/null +++ b/tools/perf/Documentation/manpage-bold-literal.xsl @@ -0,0 +1,17 @@ +<!-- manpage-bold-literal.xsl: +     special formatting for manpages rendered from asciidoc+docbook --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" +		version="1.0"> + +<!-- render literal text as bold (instead of plain or monospace); +     this makes literal text easier to distinguish in manpages +     viewed on a tty --> +<xsl:template match="literal"> +	<xsl:value-of select="$git.docbook.backslash"/> +	<xsl:text>fB</xsl:text> +	<xsl:apply-templates/> +	<xsl:value-of select="$git.docbook.backslash"/> +	<xsl:text>fR</xsl:text> +</xsl:template> + +</xsl:stylesheet> diff --git a/tools/perf/Documentation/manpage-normal.xsl b/tools/perf/Documentation/manpage-normal.xsl new file mode 100644 index 00000000000..a48f5b11f3d --- /dev/null +++ b/tools/perf/Documentation/manpage-normal.xsl @@ -0,0 +1,13 @@ +<!-- manpage-normal.xsl: +     special settings for manpages rendered from asciidoc+docbook +     handles anything we want to keep away from docbook-xsl 1.72.0 --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" +		version="1.0"> + +<xsl:import href="manpage-base.xsl"/> + +<!-- these are the normal values for the roff control characters --> +<xsl:param name="git.docbook.backslash">\</xsl:param> +<xsl:param name="git.docbook.dot"	>.</xsl:param> + +</xsl:stylesheet> diff --git a/tools/perf/Documentation/manpage-suppress-sp.xsl b/tools/perf/Documentation/manpage-suppress-sp.xsl new file mode 100644 index 00000000000..a63c7632a87 --- /dev/null +++ b/tools/perf/Documentation/manpage-suppress-sp.xsl @@ -0,0 +1,21 @@ +<!-- manpage-suppress-sp.xsl: +     special settings for manpages rendered from asciidoc+docbook +     handles erroneous, inline .sp in manpage output of some +     versions of docbook-xsl --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" +		version="1.0"> + +<!-- attempt to work around spurious .sp at the tail of the line +     that some versions of docbook stylesheets seem to add --> +<xsl:template match="simpara"> +  <xsl:variable name="content"> +    <xsl:apply-templates/> +  </xsl:variable> +  <xsl:value-of select="normalize-space($content)"/> +  <xsl:if test="not(ancestor::authorblurb) and +                not(ancestor::personblurb)"> +    <xsl:text>

</xsl:text> +  </xsl:if> +</xsl:template> + +</xsl:stylesheet> diff --git a/tools/perf/Documentation/perf-annotate.txt b/tools/perf/Documentation/perf-annotate.txt new file mode 100644 index 00000000000..c9dcade0683 --- /dev/null +++ b/tools/perf/Documentation/perf-annotate.txt @@ -0,0 +1,29 @@ +perf-annotate(1) +============== + +NAME +---- +perf-annotate - Read perf.data (created by perf record) and display annotated code + +SYNOPSIS +-------- +[verse] +'perf annotate' [-i <file> | --input=file] symbol_name + +DESCRIPTION +----------- +This command reads the input file and displays an annotated version of the +code. If the object file has debug symbols then the source code will be +displayed alongside assembly code. + +If there is no debug info in the object, then annotated assembly is displayed. + +OPTIONS +------- +-i:: +--input=:: +        Input file name. (default: perf.data) + +SEE ALSO +-------- +linkperf:perf-record[1] diff --git a/tools/perf/Documentation/perf-help.txt b/tools/perf/Documentation/perf-help.txt new file mode 100644 index 00000000000..514391818d1 --- /dev/null +++ b/tools/perf/Documentation/perf-help.txt @@ -0,0 +1,38 @@ +perf-help(1) +============ + +NAME +---- +perf-help - display help information about perf + +SYNOPSIS +-------- +'perf help' [-a|--all] [COMMAND] + +DESCRIPTION +----------- + +With no options and no COMMAND given, the synopsis of the 'perf' +command and a list of the most commonly used perf commands are printed +on the standard output. + +If the option '--all' or '-a' is given, then all available commands are +printed on the standard output. + +If a perf command is named, a manual page for that command is brought +up. The 'man' program is used by default for this purpose, but this +can be overridden by other options or configuration variables. + +Note that `perf --help ...` is identical to `perf help ...` because the +former is internally converted into the latter. + +OPTIONS +------- +-a:: +--all:: +	Prints all the available commands on the standard output. This +	option supersedes any other option. + +PERF +---- +Part of the linkperf:perf[1] suite diff --git a/tools/perf/Documentation/perf-list.txt b/tools/perf/Documentation/perf-list.txt new file mode 100644 index 00000000000..8290b942266 --- /dev/null +++ b/tools/perf/Documentation/perf-list.txt @@ -0,0 +1,25 @@ +perf-list(1) +============ + +NAME +---- +perf-list - List all symbolic event types + +SYNOPSIS +-------- +[verse] +'perf list' + +DESCRIPTION +----------- +This command displays the symbolic event types which can be selected in the +various perf commands with the -e option. + +OPTIONS +------- +None + +SEE ALSO +-------- +linkperf:perf-stat[1], linkperf:perf-top[1], +linkperf:perf-record[1] diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt new file mode 100644 index 00000000000..1dbc1eeb4c0 --- /dev/null +++ b/tools/perf/Documentation/perf-record.txt @@ -0,0 +1,42 @@ +perf-record(1) +============== + +NAME +---- +perf-record - Run a command and record its profile into perf.data + +SYNOPSIS +-------- +[verse] +'perf record' [-e <EVENT> | --event=EVENT] [-l] [-a] <command> +'perf record' [-e <EVENT> | --event=EVENT] [-l] [-a] -- <command> [<options>] + +DESCRIPTION +----------- +This command runs a command and gathers a performance counter profile +from it, into perf.data - without displaying anything. + +This file can then be inspected later on, using 'perf report'. + + +OPTIONS +------- +<command>...:: +	Any command you can specify in a shell. + +-e:: +--event=:: +	Select the PMU event. Selection can be a symbolic event name +	(use 'perf list' to list all events) or a raw PMU +	event (eventsel+umask) in the form of rNNN where NNN is a +	 hexadecimal event descriptor. + +-a:: +        system-wide collection + +-l:: +        scale counter values + +SEE ALSO +-------- +linkperf:perf-stat[1], linkperf:perf-list[1] diff --git a/tools/perf/Documentation/perf-report.txt b/tools/perf/Documentation/perf-report.txt new file mode 100644 index 00000000000..52d3fc6846a --- /dev/null +++ b/tools/perf/Documentation/perf-report.txt @@ -0,0 +1,26 @@ +perf-report(1) +============== + +NAME +---- +perf-report - Read perf.data (created by perf record) and display the profile + +SYNOPSIS +-------- +[verse] +'perf report' [-i <file> | --input=file] + +DESCRIPTION +----------- +This command displays the performance counter profile information recorded +via perf report. + +OPTIONS +------- +-i:: +--input=:: +        Input file name. (default: perf.data) + +SEE ALSO +-------- +linkperf:perf-stat[1] diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt new file mode 100644 index 00000000000..c368a72721d --- /dev/null +++ b/tools/perf/Documentation/perf-stat.txt @@ -0,0 +1,66 @@ +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> +'perf stat' [-e <EVENT> | --event=EVENT] [-l] [-a] -- <command> [<options>] + +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=:: +	Select the PMU event. Selection can be a symbolic event name +	(use 'perf list' to list all events) or a raw PMU +	event (eventsel+umask) in the form of rNNN where NNN is a +	 hexadecimal event descriptor. + +-i:: +--inherit:: +        child tasks inherit counters +-p:: +--pid=<pid>:: +        stat events on existing pid + +-a:: +        system-wide collection + +-l:: +        scale counter values + +EXAMPLES +-------- + +$ perf stat -- make -j + + Performance counter stats for 'make -j': + +    8117.370256  task clock ticks     #      11.281 CPU utilization factor +            678  context switches     #       0.000 M/sec +            133  CPU migrations       #       0.000 M/sec +         235724  pagefaults           #       0.029 M/sec +    24821162526  CPU cycles           #    3057.784 M/sec +    18687303457  instructions         #    2302.138 M/sec +      172158895  cache references     #      21.209 M/sec +       27075259  cache misses         #       3.335 M/sec + + Wall-clock time elapsed:   719.554352 msecs + +SEE ALSO +-------- +linkperf:perf-top[1], linkperf:perf-list[1] diff --git a/tools/perf/Documentation/perf-top.txt b/tools/perf/Documentation/perf-top.txt new file mode 100644 index 00000000000..539d0128972 --- /dev/null +++ b/tools/perf/Documentation/perf-top.txt @@ -0,0 +1,39 @@ +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=:: +	Select the PMU event. Selection can be a symbolic event name +	(use 'perf list' to list all events) or a raw PMU +	event (eventsel+umask) in the form of rNNN where NNN is a +	 hexadecimal event descriptor. + +-a:: +        system-wide collection + +-l:: +        scale counter values + +SEE ALSO +-------- +linkperf:perf-stat[1], linkperf:perf-list[1] diff --git a/tools/perf/Documentation/perf.txt b/tools/perf/Documentation/perf.txt new file mode 100644 index 00000000000..69c83255719 --- /dev/null +++ b/tools/perf/Documentation/perf.txt @@ -0,0 +1,24 @@ +perf(1) +======= + +NAME +---- +perf - Performance analysis tools for Linux + +SYNOPSIS +-------- +[verse] +'perf' [--version] [--help] COMMAND [ARGS] + +DESCRIPTION +----------- +Performance counters for Linux are are a new kernel-based subsystem +that provide a framework for all things performance analysis. It +covers hardware level (CPU/PMU, Performance Monitoring Unit) features +and software features (software counters, tracepoints) as well. + +SEE ALSO +-------- +linkperf:perf-stat[1], linkperf:perf-top[1], +linkperf:perf-record[1], linkperf:perf-report[1], +linkperf:perf-list[1]  | 
