lttng-add-context(1): add missing man: prefix

[lttng-tools.git] / doc / man / lttng-add-context.1.txt

diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt
index 26df16d2b37fb102587120dcfa6c2ec784b65b43..e3c8813b5ce13466a70511198f0a428e77eedebe 100644 (file)
--- a/doc/man/lttng-add-context.1.txt
+++ b/doc/man/lttng-add-context.1.txt
@@ -12,7 +12,7 @@ SYNOPSIS
 Add context fields to a channel:
 
 [verse]
-*lttng* ['GENERAL OPTIONS'] *add-context*
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context*
       (option:--kernel | option:--userspace | option:--jul | option:--log4j)
       [option:--session='SESSION'] [option:--channel='CHANNEL']
       option:--type='TYPE' [option:--type='TYPE']...
@@ -20,7 +20,7 @@ Add context fields to a channel:
 List the available context fields:
 
 [verse]
-*lttng* ['GENERAL OPTIONS'] *add-context* --list
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context* option:--list
 
 
 DESCRIPTION
@@ -28,7 +28,7 @@ DESCRIPTION
 The `lttng add-context` command adds one or more context fields to a
 channel.
 
-Channels are created with the linklttng:lttng-enable-channel(1) command.
+Channels are created with the man:lttng-enable-channel(1) command.
 
 When context fields are added to a channel, all the events emitted
 within this channel contain the dynamic values of those context fields.
@@ -45,6 +45,19 @@ per-thread (`perf:thread:` prefix) counters. Currently, per-CPU counters
 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: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:
 
@@ -59,6 +72,10 @@ with:
 'TYPE'::
     Context type name.
 
+NOTE: Make sure to **single-quote** the type when running the command
+from a shell, as `$` is a special character for variable substitution in
+most shells.
+
 Use the option:--list option without other arguments to list the
 available context field names.
 
@@ -85,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.
 
@@ -99,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.
 
@@ -112,4 +129,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)