Docs(CLI): Mention the new error reports

Signed-off-by: Paul Mabileau <paulmabileau@hotmail.fr>
PaulDance · Feb 25, 2024 · 400f7b8 · 400f7b8
1 parent d509bba
commit 400f7b8
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -177,12 +177,15 @@ Options:
           
           When omitted, INFO and above messages of only this crate
           are logged. When used once, DEBUG and above messages of
-          only this crate are logged. When used twice, DEBUG and
-          above messages of all crates are logged, and `-v` is given
-          to Cargo calls (details ran commands). When used three
-          times or more, TRACE and above messages of all crates are
-          logged, and `-vv` is given to Cargo calls (includes build
-          output). This takes precedence over the environment.
+          only this crate are logged and error backtraces are shown
+          (`RUST_BACKTRACE=1`). When used twice, DEBUG and above
+          messages of all crates are logged, `-v` is given to Cargo
+          calls (details ran commands), and error backtraces are
+          fully shown (`RUST_BACKTRACE=full`). When used three times
+          or more, TRACE and above messages of all crates are logged,
+          `-vv` is given to Cargo calls (includes build output) and
+          error backtraces are fully shown (`RUST_BACKTRACE=full`).
+          This takes precedence over the environment.
 
   -q, --quiet...
           Be quieter. Use multiple times to be more and more so each
@@ -193,15 +196,16 @@ Options:
           this crate are logged. When used twice, ERROR messages of
           all crates are logged. When used three times or more, no
           message will be logged, including Cargo's by passing `-q`
-          to it. This takes precedence over the environment.
+          to it and error reports are silenced. This takes precedence
+          over the environment.
 
       --color <WHEN>
           Control the coloring of the logging output.
           
           This enables one to manually specify when should the logs
-          be colored or not, for example if the automatic detection
-          is either not wished or not functional. The value is also
-          passed onto calls to Cargo.
+          and error reports be colored or not, for example if the
+          automatic detection is either not wished or not functional.
+          The value is also passed onto calls to Cargo.
           
           [default: auto]
           [possible values: auto, always, never]
@@ -331,12 +335,15 @@ Options:
           
           When omitted, INFO and above messages of only this crate
           are logged. When used once, DEBUG and above messages of
-          only this crate are logged. When used twice, DEBUG and
-          above messages of all crates are logged, and `-v` is given
-          to Cargo calls (details ran commands). When used three
-          times or more, TRACE and above messages of all crates are
-          logged, and `-vv` is given to Cargo calls (includes build
-          output). This takes precedence over the environment.
+          only this crate are logged and error backtraces are shown
+          (`RUST_BACKTRACE=1`). When used twice, DEBUG and above
+          messages of all crates are logged, `-v` is given to Cargo
+          calls (details ran commands), and error backtraces are
+          fully shown (`RUST_BACKTRACE=full`). When used three times
+          or more, TRACE and above messages of all crates are logged,
+          `-vv` is given to Cargo calls (includes build output) and
+          error backtraces are fully shown (`RUST_BACKTRACE=full`).
+          This takes precedence over the environment.
 
   -q, --quiet...
           Be quieter. Use multiple times to be more and more so each
@@ -347,15 +354,16 @@ Options:
           this crate are logged. When used twice, ERROR messages of
           all crates are logged. When used three times or more, no
           message will be logged, including Cargo's by passing `-q`
-          to it. This takes precedence over the environment.
+          to it and error reports are silenced. This takes precedence
+          over the environment.
 
       --color <WHEN>
           Control the coloring of the logging output.
           
           This enables one to manually specify when should the logs
-          be colored or not, for example if the automatic detection
-          is either not wished or not functional. The value is also
-          passed onto calls to Cargo.
+          and error reports be colored or not, for example if the
+          automatic detection is either not wished or not functional.
+          The value is also passed onto calls to Cargo.
           
           [default: auto]
           [possible values: auto, always, never]
@@ -457,12 +465,15 @@ Options:
           
           When omitted, INFO and above messages of only this crate
           are logged. When used once, DEBUG and above messages of
-          only this crate are logged. When used twice, DEBUG and
-          above messages of all crates are logged, and `-v` is given
-          to Cargo calls (details ran commands). When used three
-          times or more, TRACE and above messages of all crates are
-          logged, and `-vv` is given to Cargo calls (includes build
-          output). This takes precedence over the environment.
+          only this crate are logged and error backtraces are shown
+          (`RUST_BACKTRACE=1`). When used twice, DEBUG and above
+          messages of all crates are logged, `-v` is given to Cargo
+          calls (details ran commands), and error backtraces are
+          fully shown (`RUST_BACKTRACE=full`). When used three times
+          or more, TRACE and above messages of all crates are logged,
+          `-vv` is given to Cargo calls (includes build output) and
+          error backtraces are fully shown (`RUST_BACKTRACE=full`).
+          This takes precedence over the environment.
 
   -q, --quiet...
           Be quieter. Use multiple times to be more and more so each
@@ -473,15 +484,16 @@ Options:
           this crate are logged. When used twice, ERROR messages of
           all crates are logged. When used three times or more, no
           message will be logged, including Cargo's by passing `-q`
-          to it. This takes precedence over the environment.
+          to it and error reports are silenced. This takes precedence
+          over the environment.
 
       --color <WHEN>
           Control the coloring of the logging output.
           
           This enables one to manually specify when should the logs
-          be colored or not, for example if the automatic detection
-          is either not wished or not functional. The value is also
-          passed onto calls to Cargo.
+          and error reports be colored or not, for example if the
+          automatic detection is either not wished or not functional.
+          The value is also passed onto calls to Cargo.
           
           [default: auto]
           [possible values: auto, always, never]

diff --git a/src/cli.rs b/src/cli.rs
@@ -34,11 +34,14 @@ pub struct LinerArgs {
     /// Be more verbose. Use multiple times to be more and more so each time.
     ///
     /// When omitted, INFO and above messages of only this crate are logged.
-    /// When used once, DEBUG and above messages of only this crate are logged.
-    /// When used twice, DEBUG and above messages of all crates are logged, and
-    /// `-v` is given to Cargo calls (details ran commands).
+    /// When used once, DEBUG and above messages of only this crate are logged
+    /// and error backtraces are shown (`RUST_BACKTRACE=1`).
+    /// When used twice, DEBUG and above messages of all crates are logged,
+    /// `-v` is given to Cargo calls (details ran commands), and error
+    /// backtraces are fully shown (`RUST_BACKTRACE=full`).
     /// When used three times or more, TRACE and above messages of all crates
-    /// are logged, and `-vv` is given to Cargo calls (includes build output).
+    /// are logged, `-vv` is given to Cargo calls (includes build output) and
+    /// error backtraces are fully shown (`RUST_BACKTRACE=full`).
     /// This takes precedence over the environment.
     #[arg(
         short,
@@ -56,7 +59,7 @@ pub struct LinerArgs {
     /// When used once, WARN and above messages of only this crate are logged.
     /// When used twice, ERROR messages of all crates are logged.
     /// When used three times or more, no message will be logged, including
-    /// Cargo's by passing `-q` to it.
+    /// Cargo's by passing `-q` to it and error reports are silenced.
     /// This takes precedence over the environment.
     #[arg(
         short,
@@ -70,9 +73,10 @@ pub struct LinerArgs {
 
     /// Control the coloring of the logging output.
     ///
-    /// This enables one to manually specify when should the logs be colored or
-    /// not, for example if the automatic detection is either not wished or not
-    /// functional. The value is also passed onto calls to Cargo.
+    /// This enables one to manually specify when should the logs and error
+    /// reports be colored or not, for example if the automatic detection is
+    /// either not wished or not functional. The value is also passed onto
+    /// calls to Cargo.
     #[arg(
         long,
         global = true,