From: Philippe Proulx Date: Thu, 24 Mar 2016 06:52:29 +0000 (-0400) Subject: doc/man: add [role="term"] to terminal callouts X-Git-Tag: v2.9.0-rc1~324 X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=d4f093aa457acf5492c099f40badcc8379c95fe9 doc/man: add [role="term"] to terminal callouts This does not change the troff output, but it annotates the given callouts in the DocBook output so that a DocBook->HTML stylesheet can use this role to visually differentiate terminal callouts from generic callouts. Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- diff --git a/doc/man/README.md b/doc/man/README.md index 4a5cbdfc6..eb73ded2c 100644 --- a/doc/man/README.md +++ b/doc/man/README.md @@ -63,7 +63,7 @@ writing new ones: * Always use macros when possible (link to other LTTng man page, command-line option, NOT, etc.). - * Use callouts for command-line examples. + * Use callouts with the `term` role for command-line examples. * Always refer to _long_ options in the text. * Use the `option:--option=parameter` format (with `=`) when providing a parameter to long options. diff --git a/doc/man/lttng-calibrate.1.txt b/doc/man/lttng-calibrate.1.txt index 71db0e50c..621a67a88 100644 --- a/doc/man/lttng-calibrate.1.txt +++ b/doc/man/lttng-calibrate.1.txt @@ -38,6 +38,7 @@ hooked on an empty function, gathering PMU counters LLC (Last Level Cache) misses information (use `lttng add-context --list` to get the list of available PMU counters). +[role="term"] ------------------------------------------------------------------------ lttng create calibrate-function lttng enable-event calibrate --kernel \ diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt index e238830d3..b5e7c947d 100644 --- a/doc/man/lttng-enable-channel.1.txt +++ b/doc/man/lttng-enable-channel.1.txt @@ -209,6 +209,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 diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt index f33507cec..b58691ba0 100644 --- a/doc/man/lttng-enable-event.1.txt +++ b/doc/man/lttng-enable-event.1.txt @@ -106,6 +106,7 @@ a _don't care_. For example, consider the following commands: +[role="term"] ---------------------------------------------------------------- lttng enable-event --userspace hello:world lttng enable-event --userspace hello:world --loglevel=TRACE_INFO diff --git a/doc/man/lttng-help.1.txt b/doc/man/lttng-help.1.txt index 132c5d62d..c0f4d6442 100644 --- a/doc/man/lttng-help.1.txt +++ b/doc/man/lttng-help.1.txt @@ -20,6 +20,7 @@ command. This command is the equivalent of: +[role="term"] -------------------- lttng COMMAND --help -------------------- diff --git a/doc/man/lttng-status.1.txt b/doc/man/lttng-status.1.txt index 89bfca851..b156db0a7 100644 --- a/doc/man/lttng-status.1.txt +++ b/doc/man/lttng-status.1.txt @@ -20,6 +20,7 @@ tracing session. This command is the exact equivalent of: +[role="term"] --------------------- lttng list CURSESSION --------------------- diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt index 899a6c4ea..9e0d2263f 100644 --- a/doc/man/lttng-track.1.txt +++ b/doc/man/lttng-track.1.txt @@ -35,6 +35,7 @@ events (equivalent of `lttng track --pid --all` for all domains). With the PID tracker, it is possible, for example, to record all system calls called by a given process: +[role="term"] ------------------------------------------- lttng enable-event --kernel --all --syscall lttng track --kernel --pid=2345 @@ -60,6 +61,7 @@ Initial whitelist: Command: +[role="term"] ----------------------------------- lttng track --userspace --pid=3,6,7 ----------------------------------- @@ -72,6 +74,7 @@ Whitelist: Command: +[role="term"] --------------------------------- lttng untrack --userspace --pid=7 --------------------------------- @@ -84,6 +87,7 @@ Whitelist: Command: +[role="term"] --------------------------------- lttng track --userspace --pid=1,5 --------------------------------- diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt index 8226e1ada..b57150633 100644 --- a/doc/man/lttng-untrack.1.txt +++ b/doc/man/lttng-untrack.1.txt @@ -40,6 +40,7 @@ Assume the maximum system PID is 7 for this example. Command: +[role="term"] ------------ lttng create ------------ @@ -52,6 +53,7 @@ Initial whitelist: Command: +[role="term"] ------------------------------------- lttng untrack --userspace --pid --all ------------------------------------- @@ -64,10 +66,11 @@ Whitelist: Commands: +[role="term"] ---------------------------------- lttng enable-event --userspace ... lttng start -... +# ... lttng track --userspace --pid=3,5 ---------------------------------- @@ -79,6 +82,7 @@ Whitelist: Command: +[role="term"] ------------------------------- lttng track --userspace --pid=2 -------------------------------