From: Philippe Proulx Date: Thu, 6 May 2021 19:15:29 +0000 (-0400) Subject: lttng-add-context(1): use a description list to explain `--channel` X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=f14111c9af633ef85f82a6b61eed47228ab2cf3a;p=lttng-tools.git lttng-add-context(1): use a description list to explain `--channel` Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau Change-Id: Ie2d701820bf1e086205254c0712fe088c3295b2d --- diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt index ad83445b5..237467850 100644 --- a/doc/man/lttng-add-context.1.txt +++ b/doc/man/lttng-add-context.1.txt @@ -31,7 +31,7 @@ The `lttng add-context` command can: Without the option:--list option:: Add one or more context fields to be recorded by LTTng to the event - records of a given channel, or of all the channels of: + records of: + With the option:--session='SESSION' option::: The tracing session named 'SESSION'. @@ -40,16 +40,18 @@ Without the option:--session option::: The current tracing session (see man:lttng-concepts(7) to learn more about the current tracing session). +With the option:--channel='CHANNEL'::: + The channel named 'CHANNEL'. + +Without the option:--channel option::: + *All* the channels of the selected tracing session. + With the option:--list option:: List the available context field types. See man:lttng-concepts(7) to learn more about tracing sessions and channels. -Without the option:--channel option, LTTng adds context fields to be -recorded to the event records of *all* the channels of the selected -tracing session. - Repeat the option:--type='TYPE' option to add more than one context field to be recorded. 'TYPE' is one of: