X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-add-context.1.txt;h=e3c8813b5ce13466a70511198f0a428e77eedebe;hp=a1e0fe78f14035015e00c7bd4185b9f3f7a2b732;hb=deb35f495e89dd75b7fef7ffe46dc2301bd29c69;hpb=4fe444dafd2243de56091ab5dd7efa0050b0597f diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt index a1e0fe78f..e3c8813b5 100644 --- a/doc/man/lttng-add-context.1.txt +++ b/doc/man/lttng-add-context.1.txt @@ -46,13 +46,17 @@ can only be used in the Linux kernel tracing domain, while per-thread counters can only be used in the user space tracing domain. It is also possible to enable PMU counters by raw ID using the -`perf:cpu:raw:r:` or `perf:thread:raw:r:` format for -the kernel and user-space respectively. `` is a hexadecimal event -descriptor which is the same format as used by perf-record(1): a -concatenation of the `Umask value` and `Event number` provided by the -processor's manufacturer. The possible values for this field are -processor-specific. The `` field is used to associate a clearer -name to the counter. +`perf:cpu:raw:rN:NAME` (Linux kernel tracing domain) or +`perf:thread:raw:rN:NAME` (user space tracing domain), with: + +`N`:: + A hexadecimal event descriptor which is the same format as used + by man:perf-record(1): a concatenation of the event number and umask + value provided by the processor's manufacturer. The possible values + for this field are processor-specific. + +`NAME`:: + Custom name to easily recognize the counter. Application-specific context fields can be added to a channel using the following syntax: @@ -98,11 +102,11 @@ option:-u, option:--userspace:: Target ~~~~~~ -option:-c, option:--channel='CHANNEL':: +option:-c 'CHANNEL', option:--channel='CHANNEL':: Add context fields to a channel named 'CHANNEL' instead of adding them to all the channels. -option:-s, option:--session='SESSION':: +option:-s 'SESSION', option:--session='SESSION':: Add context fields to a channel in the tracing session named 'SESSION' instead of the current tracing session. @@ -112,7 +116,7 @@ Context option:--list:: List the available context fields. Use this option alone. -option:-t, option:--type='TYPE':: +option:-t 'TYPE', option:--type='TYPE':: Add context field named 'TYPE'. This option can be repeated as many times as needed on the command-line.