X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-add-context.1.txt;h=f995a7fbe2fd629f1091c68427edc30fc3410db8;hb=767ab8b2ad2c59123ba076ec149832e1f34202b1;hp=26df16d2b37fb102587120dcfa6c2ec784b65b43;hpb=2e4886b88e065d5d6b089d3d4d92ef06434fe5d1;p=lttng-tools.git

diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt
index 26df16d2b..f995a7fbe 100644
--- 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.
@@ -59,6 +59,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.
 
@@ -112,4 +116,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)