doc/man: make default values of boolean init. params. clearer

[babeltrace.git] / doc / man / babeltrace2-filter.lttng-utils.debug-info.7.txt

diff --git a/doc/man/babeltrace2-filter.lttng-utils.debug-info.7.txt b/doc/man/babeltrace2-filter.lttng-utils.debug-info.7.txt
index 090d07bdc8e7cbe019917bf93c1e5a953509812d..bccd85491c262e72b2b3bf6e63d7f35b52b1ca0c 100644 (file)
--- a/doc/man/babeltrace2-filter.lttng-utils.debug-info.7.txt
+++ b/doc/man/babeltrace2-filter.lttng-utils.debug-info.7.txt
@@ -1,6 +1,6 @@
 = babeltrace2-filter.lttng-utils.debug-info(7)
 :manpagetype: component class
-:revdate: 14 September 2019
+:revdate: 1 September 2023
 :compcls: compcls:filter.lttng-utils.debug-info
 :defdebuginfoname: `debug_info`
 
@@ -62,7 +62,7 @@ Example: `load_user_config+0x194`.
 
 [[field-src]]`src` vtype:[string]::
     Source file path or name followed with `:LINE`, where `LINE` is the
-    line number in this source file at which the event occured.
+    line number in this source file at which the event occurred.
 +
 Example: `user-config.c:1025`.
 
@@ -97,7 +97,7 @@ In this case, the events that the message iterator creates do not
 contain the source file and line number (see the <<field-src,`src`
 field>>), but only the name of the nearest function symbol with an
 offset in bytes to the location in the executable from which the LTTng
-event occured (see the <<field-func,`func` field>>).
+event occurred (see the <<field-func,`func` field>>).
 
 If the executable file has neither ELF symbols nor DWARF information,
 the {compcls} message iterator cannot map the event to its source
@@ -229,10 +229,12 @@ param:debug-info-field-name='NAME' vtype:[optional string]::
     of the created events 'NAME' instead of the default
     {defdebuginfoname}.
 
-param:full-path=`yes` vtype:[optional boolean]::
-    Use the full path when writing the executable name (`bin`) and
-    source file name (`src`) fields in the {defdebuginfoname} context
-    field of the created events.
+param:full-path='VAL' vtype:[optional boolean]::
+    If 'VAL' is true, then use the full path when writing the executable
+    name (`bin`) and source file name (`src`) fields in the
+    {defdebuginfoname} context field of the created events.
++
+Default: false.
 
 param:target-prefix='DIR' vtype:[optional string]::
     Use 'DIR' as the root directory of the target file system instead of