Convert documentation to AsciiDoc

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

diff --git a/common/convention.txt b/common/convention.txt
new file mode 100644 (file)
index 0000000..b725241
--- /dev/null
+++ b/common/convention.txt
@@ -0,0 +1,25 @@
+[[convention]]
+=== Convention
+
+Function names, parameter names, variable names, command names, argument
+names, file system paths, file names, and other literal strings are
+written using a `monospace typeface` in this document. An +_italic_
+word+ within such a block is a placeholder, usually described in the
+following sentence.
+
+Practical tips and notes are given throughout the document using the
+following style:
+
+TIP: Make sure you read the tips.
+
+Terminal boxes are used to show command lines:
+
+[role="term"]
+----
+echo This is a terminal box
+----
+
+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.