X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=common%2Fconvention.txt;h=edb6174b553389279ac921aca8fce8a8375276c4;hb=ded026983bfe6b3ba0365bba59c93b4aa55bb37a;hp=b72524178b34b651b1cd59738ecc82c603f5771c;hpb=85de609516bbb92d4428c86e502e34f8c96a474d;p=lttng-docs.git diff --git a/common/convention.txt b/common/convention.txt index b725241..edb6174 100644 --- 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.