X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-enable-channel.1.txt;h=9365a7806e658fb1fd30a7e7e4a0896a0085a8d1;hb=790e4a4c3a7bb09ee6d9786b704424ba5dcbf90e;hp=e238830d3bc63aafb722741dcd79897e80fc7612;hpb=b4867b3be09b040aa8da32d0fa417ff1ec2a40f9;p=lttng-tools.git diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt index e238830d3..9365a7806 100644 --- a/doc/man/lttng-enable-channel.1.txt +++ b/doc/man/lttng-enable-channel.1.txt @@ -12,7 +12,7 @@ SYNOPSIS Create a Linux kernel channel: [verse] -*lttng* ['GENERAL OPTIONS'] *enable-channel* option:--kernel +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* option:--kernel [option:--discard | option:--overwrite] [option:--output=(`mmap` | `splice`)] [option:--subbuf-size='SIZE'] [option:--num-subbuf='COUNT'] [option:--switch-timer='PERIODUS'] [option:--read-timer='PERIODUS'] @@ -22,7 +22,7 @@ Create a Linux kernel channel: Create a user space channel: [verse] -*lttng* ['GENERAL OPTIONS'] *enable-channel* option:--userspace +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* option:--userspace [option:--discard | option:--overwrite] [option:--buffers-pid] [option:--subbuf-size='SIZE'] [option:--num-subbuf='COUNT'] [option:--switch-timer='PERIODUS'] [option:--read-timer='PERIODUS'] @@ -32,7 +32,7 @@ Create a user space channel: Enable existing channel(s): [verse] -*lttng* ['GENERAL OPTIONS'] *enable-channel* (option:--userspace | option:--kernel) +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* (option:--userspace | option:--kernel) [option:--session='SESSION'] 'CHANNEL'[,'CHANNEL']... @@ -64,17 +64,8 @@ Existing enabled channels can be disabled using linklttng:lttng-disable-channel(1). Channels of a given session can be listed using linklttng:lttng-list(1). -As of this version of LTTng, it is not possible to: - -* Reconfigure a channel once it is created. -* Re-enable a disabled channel once its tracing session has been active - at least once. -* Create a channel once its tracing session has been active - at least once. -* Create a user space channel with a given buffering scheme - (option:--buffers-uid or option:--buffers-pid options) and create - a second user space channel with a different buffering scheme in the - same tracing session. +See the <> section below for a list of +limitations of this command to consider. Event loss modes @@ -209,6 +200,7 @@ in conjunction with the option:--tracefile-size option. For example, consider this command: +[role="term"] ----------------------------------------------------- lttng enable-channel --kernel --tracefile-size=4096 \ --tracefile-count=32 my-channel @@ -352,6 +344,23 @@ option:--switch-timer='PERIODUS':: include::common-cmd-help-options.txt[] +[[limitations]] +LIMITATIONS +----------- +As of this version of LTTng, it is not possible to perform the following +actions with the `lttng enable-channel` command: + +* Reconfigure a channel once it is created. +* Re-enable a disabled channel once its tracing session has been active + at least once. +* Create a channel once its tracing session has been active + at least once. +* Create a user space channel with a given buffering scheme + (option:--buffers-uid or option:--buffers-pid options) and create + a second user space channel with a different buffering scheme in the + same tracing session. + + include::common-cmd-footer.txt[]