2.8, 2.9: use `$` and `#` prompts in terminal boxes

[lttng-docs.git] / common / convention.txt

diff --git a/common/convention.txt b/common/convention.txt
index b72524178b34b651b1cd59738ecc82c603f5771c..edb6174b553389279ac921aca8fce8a8375276c4 100644 (file)
--- a/common/convention.txt
+++ b/common/convention.txt
@@ -16,10 +16,10 @@ Terminal boxes are used to show command lines:
 
 [role="term"]
 ----
-echo This is a terminal box
+$ echo Command line as a regular user
+# echo Command line as a priviledged user
 ----
 
-Typical command prompts, like `$` and `#`, are not shown in terminal
-boxes to make copy operations easier, especially for multiline commands
-which you can copy and paste as is to your terminal. Command lines
-which you need to execute as a root user start with cmd:sudo.
+Command lines which you need to execute as a priviledged user start with
+the `#` prompt or with `sudo`. Other command lines start with the `$`
+prompt.