Commit b0aaf4c8 authored by Ravi Bangoria's avatar Ravi Bangoria Committed by Arnaldo Carvalho de Melo
Browse files

perf config: Document missing config options 



While documenting annotate.show_nr_samples config option, I found many
other config options missing in perf-config documentation. Add them.

Signed-off-by: default avatarRavi Bangoria <ravi.bangoria@linux.ibm.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexey Budankov <alexey.budankov@linux.intel.com>
Cc: Changbin Du <changbin.du@intel.com>
Cc: Ian Rogers <irogers@google.com>
Cc: Jin Yao <yao.jin@linux.intel.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Leo Yan <leo.yan@linaro.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Song Liu <songliubraving@fb.com>
Cc: Taeung Song <treeze.taeung@gmail.com>
Cc: Thomas Richter <tmricht@linux.ibm.com>
Cc: Yisheng Xie <xieyisheng1@huawei.com>
Link: http://lore.kernel.org/lkml/20200213064306.160480-9-ravi.bangoria@linux.ibm.com


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent cd0a9c51

tools/perf/Documentation/perf-config.txt

+44 −0
Original line number Diff line number Diff line
@@ -518,6 +518,12 @@ top.*:: 
		column by default.

		The default is 'true'.



	top.call-graph::

		This is identical to 'call-graph.record-mode', except it is

		applicable only for 'top' subcommand. This option ONLY setup

		the unwind method. To enable 'perf top' to actually use it,

		the command line option -g must be specified.



man.*::

	man.viewer::

		This option can assign a tool to view manual pages when 'help'
@@ -545,6 +551,16 @@ record.*:: 
		But if this option is 'no-cache', it will not update the build-id cache.

		'skip' skips post-processing and does not update the cache.



	record.call-graph::

		This is identical to 'call-graph.record-mode', except it is

		applicable only for 'record' subcommand. This option ONLY setup

		the unwind method. To enable 'perf record' to actually use it,

		the command line option -g must be specified.



	record.aio::

		Use 'n' control blocks in asynchronous (Posix AIO) trace writing

		mode ('n' default: 1, max: 4).



diff.*::

	diff.order::

		This option sets the number of columns to sort the result.
@@ -594,6 +610,11 @@ trace.*:: 
		"libbeauty", the default, to use the same argument beautifiers used in the

		strace-like sys_enter+sys_exit lines.



ftrace.*::

	ftrace.tracer::

		Can be used to select the default tracer. Possible values are

		'function' and 'function_graph'.



llvm.*::

	llvm.clang-path::

		Path to clang. If omit, search it from $PATH.
@@ -638,6 +659,29 @@ scripts.*:: 
	The script gets the same options passed as a full perf script,

	in particular -i perfdata file, --cpu, --tid



convert.*::



	convert.queue-size::

		Limit the size of ordered_events queue, so we could control

		allocation size of perf data files without proper finished

		round events.



intel-pt.*::



	intel-pt.cache-divisor::



	intel-pt.mispred-all::

		If set, Intel PT decoder will set the mispred flag on all

		branches.



auxtrace.*::



	auxtrace.dumpdir::

		s390 only. The directory to save the auxiliary trace buffer

		can be changed using this option. Ex, auxtrace.dumpdir=/tmp.

		If the directory does not exist or has the wrong file type,

		the current directory is used.



SEE ALSO

--------

linkperf:perf[1]

CRA Git | Maintained and supported by SUSTech CRA and CCSE