Use double quotes for full section names

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

diff --git a/common/convention.txt b/common/convention.txt
index b72524178b34b651b1cd59738ecc82c603f5771c..a7274c2eebbf846479f911c7bc8f25d23d93aa62 100644 (file)
--- a/common/convention.txt
+++ b/common/convention.txt
@@ -10,16 +10,16 @@ following sentence.
 Practical tips and notes are given throughout the document using the
 following style:
 
-TIP: Make sure you read the tips.
+TIP: Read the tips.
 
 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 the `root` 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.