doc/man: add [role="term"] to terminal callouts
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 24 Mar 2016 06:52:29 +0000 (02:52 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 24 Mar 2016 18:57:50 +0000 (14:57 -0400)
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 <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
doc/man/README.md
doc/man/lttng-calibrate.1.txt
doc/man/lttng-enable-channel.1.txt
doc/man/lttng-enable-event.1.txt
doc/man/lttng-help.1.txt
doc/man/lttng-status.1.txt
doc/man/lttng-track.1.txt
doc/man/lttng-untrack.1.txt

index 4a5cbdfc6eeb62dcd7785615279b0081b0e9b215..eb73ded2c2ebaf114065bc0afa0e5788f6788c33 100644 (file)
@@ -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.
index 71db0e50c39e612645caae2bf79eb0d1fa395111..621a67a88ecb9b920e93f00ef7a1c3e490eb05c6 100644 (file)
@@ -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 \
index e238830d3bc63aafb722741dcd79897e80fc7612..b5e7c947d20eda9c65bfd5dc75c96ab309353146 100644 (file)
@@ -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
index f33507cec4685bd85f1151ae97597305ecf72827..b58691ba018c900a331fe2e29b3f7ff0d67af3f4 100644 (file)
@@ -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
index 132c5d62d9fe77ce239c8bb63f22aaf1e57e322c..c0f4d6442ae1c1b622398cb9f5db18acc08d0410 100644 (file)
@@ -20,6 +20,7 @@ command.
 
 This command is the equivalent of:
 
+[role="term"]
 --------------------
 lttng COMMAND --help
 --------------------
index 89bfca851b888b5d21dca9e7b04421fe806ed7c6..b156db0a724b772192610dd186e58b34d8e3fff9 100644 (file)
@@ -20,6 +20,7 @@ tracing session.
 
 This command is the exact equivalent of:
 
+[role="term"]
 ---------------------
 lttng list CURSESSION
 ---------------------
index 899a6c4eadd9b2ef0da5b242a0c32d519f7f0a7f..9e0d2263ff62594a53ca95c646e858713f3d1f37 100644 (file)
@@ -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
 ---------------------------------
index 8226e1ada3db8932ee5293b89905660c40dc2cf1..b57150633d6a66937a289baddfe0563f0d982c8c 100644 (file)
@@ -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
 -------------------------------
This page took 0.038989 seconds and 4 git commands to generate.