doc/man: add [role="term"] to terminal callouts

[lttng-tools.git] / doc / man / README.md

diff --git a/doc/man/README.md b/doc/man/README.md
index 4a5cbdfc6eeb62dcd7785615279b0081b0e9b215..eb73ded2c2ebaf114065bc0afa0e5788f6788c33 100644 (file)
--- 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.