From 7a90d4d6c6e8759b3a31b560067506751ae31b77 Mon Sep 17 00:00:00 2001 From: Jiahao XU Date: Fri, 5 Aug 2022 15:09:40 +1000 Subject: [PATCH] Improve help page for `Options::log_level` Signed-off-by: Jiahao XU --- src/main.rs | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/src/main.rs b/src/main.rs index 6e4bace0..dea6024e 100644 --- a/src/main.rs +++ b/src/main.rs @@ -8,7 +8,7 @@ use std::{ time::{Duration, Instant}, }; -use clap::{AppSettings, Parser}; +use clap::{builder::PossibleValue, AppSettings, Parser}; use compact_str::CompactString; use log::{debug, error, info, warn, LevelFilter}; use miette::{miette, Result, WrapErr}; @@ -149,9 +149,12 @@ struct Options { /// Utility log level /// /// Set to `debug` when submitting a bug report. + /// /// Set to `info` to only print useful information. - /// Set to `Warn` to only print on hazardous situations. - /// Set to `Error` to only print serious errors. + /// + /// Set to `warn` to only print on hazardous situations. + /// + /// Set to `error` to only print serious errors. /// /// Set to `off` to disable logging completely, this will also /// disable output from `cargo-install`. @@ -159,7 +162,14 @@ struct Options { help_heading = "Meta", long, default_value = "info", - value_name = "LEVEL" + value_name = "LEVEL", + possible_values = [ + PossibleValue::new("debug").help("Set to debug when submitting a bug report."), + PossibleValue::new("info").help("Set to info to only print useful information."), + PossibleValue::new("warn").help("Set to warn to only print on hazardous situations."), + PossibleValue::new("error").help("Set to error to only print serious errors."), + PossibleValue::new("off").help("Set to off to disable logging completely, this will also disable output from `cargo-install`."), + ] )] log_level: LevelFilter,