lttng-{enable-event(1),event-rule(7)}: `--filter` is not always avail.

The `--filter` option of both lttng-enable-event(1) and a common event
rule specification is not available with the Linux kprobe, kretprobe,
and user space probe instrumentation point types.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I2cea488359bbe8ac8494d785fe3282419ee66d46

diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt
index 526266fe145cf2ee46db1fe94ca7a01388e6b748..eab060cad5d7601f1c5e4581ee60f5775f845285 100644 (file)
--- a/doc/man/lttng-enable-event.1.txt
+++ b/doc/man/lttng-enable-event.1.txt
@@ -1,6 +1,6 @@
 lttng-enable-event(1)
 =====================
 lttng-enable-event(1)
 =====================

-:revdate: 3 May 2021
+:revdate: 12 May 2021

 
 
 NAME
 
 
 NAME


@@ -24,7 +24,7 @@ created from a dynamic instrumentation point:
 [verse]
 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-event* option:--kernel
       (option:--probe='LOC' | option:--function='LOC' | option:--userspace-probe='LOC') 'RECORDNAME'
 [verse]
 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-event* option:--kernel
       (option:--probe='LOC' | option:--function='LOC' | option:--userspace-probe='LOC') 'RECORDNAME'

-      [option:--filter='EXPR'] [option:--session='SESSION'] [option:--channel='CHANNEL']
+      [option:--session='SESSION'] [option:--channel='CHANNEL']

 
 Create or enable one or more recording event rules to match
 user space tracepoint events:
 
 Create or enable one or more recording event rules to match
 user space tracepoint events:


@@ -395,6 +395,10 @@ An event{nbsp}__E__ satisfies the event payload and context filter
 condition of a recording event rule if the option:--filter='EXPR'
 option is missing or if 'EXPR' is _true_.
 
 condition of a recording event rule if the option:--filter='EXPR'
 option is missing or if 'EXPR' is _true_.
 

+This condition is only meaningful for the LTTng tracepoint and Linux
+system call instrumentation point types: it's always satisfied for other
+types.
+

 'EXPR' can contain references to the payload fields of{nbsp}__E__ and
 to the current context fields.
 
 'EXPR' can contain references to the payload fields of{nbsp}__E__ and
 to the current context fields.
 


@@ -843,6 +847,9 @@ section above.
 option:-f 'EXPR', option:--filter='EXPR'::
     Only match events of which 'EXPR', which can contain references to
     event payload and current context fields, is _true_.
 option:-f 'EXPR', option:--filter='EXPR'::
     Only match events of which 'EXPR', which can contain references to
     event payload and current context fields, is _true_.

++
+This option is only available with the option:--tracepoint or
+option:--syscall option.

 
 
 include::common-lttng-cmd-help-options.txt[]
 
 
 include::common-lttng-cmd-help-options.txt[]

diff --git a/doc/man/lttng-event-rule.7.txt b/doc/man/lttng-event-rule.7.txt
index 3af260440d25ccd6f6e0cbb519a21abdc35b42e1..7f181589ceb7a9b3497eeef1ec8c1678be842886 100644 (file)
--- a/doc/man/lttng-event-rule.7.txt
+++ b/doc/man/lttng-event-rule.7.txt
@@ -1,6 +1,6 @@
 lttng-event-rule(7)
 ===================
 lttng-event-rule(7)
 ===================

-:revdate: 3 May 2021
+:revdate: 12 May 2021

 
 
 NAME
 
 
 NAME


@@ -22,7 +22,7 @@ probe events:
 
 [verse]
 option:--domain=**kernel** option:--type=(**kprobe** | **uprobe**) option:--location='LOC'
 
 [verse]
 option:--domain=**kernel** option:--type=(**kprobe** | **uprobe**) option:--location='LOC'

-pass:[[]option:--event-name='EVENTNAME'] [option:--filter='EXPR']
+pass:[[]option:--event-name='EVENTNAME']

 
 Specify an event rule to match user space tracepoint events:
 
 
 Specify an event rule to match user space tracepoint events:
 


@@ -316,6 +316,10 @@ An event{nbsp}__E__ satisfies the event payload and context filter
 condition of an event rule if the option:--filter='EXPR' option is
 missing or if 'EXPR' is _true_.
 
 condition of an event rule if the option:--filter='EXPR' option is
 missing or if 'EXPR' is _true_.
 

+This condition is only meaningful for the LTTng tracepoint and Linux
+system call instrumentation point types: it's always satisfied for other
+types.
+

 'EXPR' can contain references to the payload fields of{nbsp}__E__ and
 to the current context fields.
 
 'EXPR' can contain references to the payload fields of{nbsp}__E__ and
 to the current context fields.
 


@@ -754,6 +758,14 @@ section above.
 option:-f 'EXPR', option:--filter='EXPR'::
     Only match events of which 'EXPR', which can contain references to
     event payload and current context fields, is _true_.
 option:-f 'EXPR', option:--filter='EXPR'::
     Only match events of which 'EXPR', which can contain references to
     event payload and current context fields, is _true_.

++
+This option is only available with the following options:
++
+* option:--type=++tracepoint++
+* option:--type=++syscall++
+* option:--type=++syscall:entry++
+* option:--type=++syscall:exit++
+* option:--type=++syscall:entry+exit++

 
 
 include::common-footer.txt[]
 
 
 include::common-footer.txt[]