Fix: passing null to closedir() on error

[lttng-tools.git] / doc / man / lttng-enable-event.1.txt

diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt
index f0755333c8f6ac510ae4b88d79211b4013a29c0b..497697c91d9401be2e542e5a36416d22dffc7e01 100644 (file)
--- a/doc/man/lttng-enable-event.1.txt
+++ b/doc/man/lttng-enable-event.1.txt
@@ -42,9 +42,9 @@ An event rule created by `lttng enable-event` is a set of conditions
 that must be satisfied in order for an actual event to be emitted by
 an LTTng tracer when the execution of an application or the Linux kernel
 reaches an event source (tracepoint, system call, dynamic probe).
-Event sources can be listed with the linklttng:lttng-list(1) command.
+Event sources can be listed with the man:lttng-list(1) command.
 
-The linklttng:lttng-disable-event(1) command can be used to disable
+The man:lttng-disable-event(1) command can be used to disable
 existing event rules.
 
 Event rules are always assigned to a channel when they are created. If
@@ -56,7 +56,7 @@ If the option:--session option is omitted, the chosen channel is picked
 from the current tracing session.
 
 Events can be enabled while tracing is active
-(use linklttng:lttng-start(1) to make a tracing session active).
+(use man:lttng-start(1) to make a tracing session active).
 
 
 Event source types
@@ -163,7 +163,7 @@ When using `lttng enable-event` with a set of conditions that does not
 currently exist for the chosen tracing session, domain, and channel,
 a new event rule is created. Otherwise, the existing event rule is
 enabled if it is currently disabled
-(see linklttng:lttng-disable-event(1)).
+(see man:lttng-disable-event(1)).
 
 The option:--all option can be used alongside the option:--tracepoint
 or option:--syscall options. When this option is used, no 'EVENT'
@@ -176,10 +176,10 @@ argument named `*` (wildcard).
 [[filter-syntax]]
 Filter expression syntax
 ~~~~~~~~~~~~~~~~~~~~~~~~
-Filter expressions can be specified with the option:--filter option
-when creating a new event rule. If the filter expression evaluates
-to true when executed against the dynamic values of an event's fields
-when tracing, the filtering condition passes.
+A filter expression can be specified with the option:--filter option
+when creating a new event rule. If the filter expression evaluates to
+true when executed against the dynamic values of an event's fields when
+tracing, the filtering condition passes.
 
 NOTE: Make sure to **single-quote** the filter expression when running
 the command from a shell, as filter expressions typically include
@@ -216,17 +216,18 @@ The arithmetic and bitwise operators are :not: supported.
 The precedence table of the operators above is the same as the one of
 the C language. Parentheses are supported to bypass this.
 
-The dynamic value of an event field is read by using its name as
-a C identifier.
+The dynamic value of an event field is read by using its name as a C
+identifier.
 
 The dynamic value of a statically-known context field is read by
 prefixing its name with `$ctx.`. Statically-known context fields are
 context fields added to channels without the `$app.` prefix using the
-linklttng:lttng-add-context(1) command.
+man:lttng-add-context(1) command. `$ctx.cpu_id` is also available as the
+ID of the CPU which emits the event.
 
 The dynamic value of an application-specific context field is read by
 prefixing its name with `$app.` (follows the format used to add such a
-context field with the linklttng:lttng-add-context(1) command).
+context field with the man:lttng-add-context(1) command).
 
 When a comparison includes a non existent event field, the whole filter
 expression evaluates to false (the event is discarded).
@@ -242,7 +243,7 @@ or constants).
 NOTE: Although it is possible to filter the process ID of an event when
 the `pid` context has been added to its channel using, for example,
 `$ctx.pid == 2832`, it is recommended to use the PID tracker instead,
-which is much more efficient (see linklttng:lttng-track(1)).
+which is much more efficient (see man:lttng-track(1)).
 
 Examples:
 
@@ -353,11 +354,11 @@ option:-u, option:--userspace::
 
 Target
 ~~~~~~
-option:-c, option:--channel='CHANNEL'::
+option:-c 'CHANNEL', option:--channel='CHANNEL'::
     Create or enable event rules in the channel named 'CHANNEL' instead
     of the default channel name `channel0`.
 
-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::
     Create or enable event rules in the tracing session named 'SESSION'
     instead of the current tracing session.
 
@@ -409,13 +410,13 @@ option:--loglevel-only='LOGLEVEL'::
 
 Filtering and exclusion
 ~~~~~~~~~~~~~~~~~~~~~~~
-option:-x, option:--exclude='EVENT'[,'EVENT']...::
+option:-x 'EVENT'[,'EVENT']..., option:--exclude='EVENT'[,'EVENT']...::
     Exclude events named 'EVENT' from the event rule. This option
     can be used when the command's 'EVENT' argument contains a wildcard
     (`*`) to exclude specific names. Only available with application
     domains.
 
-option:-f, option:--filter='EXPR'::
+option:-f 'EXPR', option:--filter='EXPR'::
     Add filter expression condition to the event rule. Expression 'EXPR'
     must evaluate to true when executed against the dynamic values of
     event fields. See the <<filter-syntax,Filter expression syntax>>
@@ -437,5 +438,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-disable-event(1),
-linklttng:lttng(1)
+man:lttng-disable-event(1),
+man:lttng(1)