From 6b0a285541a2d99c0bcf455c99eb96aa5dbe358c Mon Sep 17 00:00:00 2001 From: shurizzle Date: Thu, 15 Aug 2024 00:22:47 +0200 Subject: [PATCH] refactor: rename `flags.enable_gpu` to `flags.disable_gpu` (`false` by default) (#1559) Co-authored-by: shurizzle --- schema/nightly/bottom.json | 2 +- src/constants.rs | 4 ++-- src/options.rs | 21 +++++++++++---------- src/options/args.rs | 4 ++-- src/options/config/flags.rs | 2 +- tests/integration/arg_tests.rs | 4 ++-- 6 files changed, 19 insertions(+), 18 deletions(-) diff --git a/schema/nightly/bottom.json b/schema/nightly/bottom.json index 781a524a..0e1f4b59 100644 --- a/schema/nightly/bottom.json +++ b/schema/nightly/bottom.json @@ -330,7 +330,7 @@ "null" ] }, - "enable_gpu": { + "disable_gpu": { "type": [ "boolean", "null" diff --git a/src/constants.rs b/src/constants.rs index d3053f70..bc499bda 100644 --- a/src/constants.rs +++ b/src/constants.rs @@ -330,8 +330,8 @@ pub(crate) const CONFIG_TEXT: &str = r#"# This is a default config file for bott #network_use_log = false # Hides advanced options to stop a process on Unix-like systems. #disable_advanced_kill = false -# Shows GPU(s) information -#enable_gpu = false +# Hide GPU(s) information +#disable_gpu = false # Shows cache and buffer memory #enable_cache_memory = false # How much data is stored at once in terms of time. diff --git a/src/options.rs b/src/options.rs index 4861e069..b75dd3ac 100644 --- a/src/options.rs +++ b/src/options.rs @@ -806,19 +806,20 @@ fn get_use_battery(args: &BottomArgs, config: &Config) -> bool { false } -#[allow(unused_variables)] +#[cfg(feature = "gpu")] fn get_enable_gpu(args: &BottomArgs, config: &Config) -> bool { - #[cfg(feature = "gpu")] - { - if args.gpu.enable_gpu { - return true; - } else if let Some(flags) = &config.flags { - if let Some(enable_gpu) = flags.enable_gpu { - return enable_gpu; - } - } + if args.gpu.disable_gpu { + return false; } + !config + .flags + .as_ref() + .and_then(|f| f.disable_gpu) + .unwrap_or(false) +} +#[cfg(not(feature = "gpu"))] +fn get_enable_gpu(_: &BottomArgs, _: &Config) -> bool { false } diff --git a/src/options/args.rs b/src/options/args.rs index acfd107d..d6c554ee 100644 --- a/src/options/args.rs +++ b/src/options/args.rs @@ -520,8 +520,8 @@ pub struct BatteryArgs { #[derive(Args, Clone, Debug, Default)] #[command(next_help_heading = "GPU Options", rename_all = "snake_case")] pub struct GpuArgs { - #[arg(long, action = ArgAction::SetTrue, help = "Enable collecting and displaying GPU usage.")] - pub enable_gpu: bool, + #[arg(long, action = ArgAction::SetTrue, help = "Disable collecting and displaying GPU usage.")] + pub disable_gpu: bool, } /// Style arguments/config options. diff --git a/src/options/config/flags.rs b/src/options/config/flags.rs index feb10f5f..1d020e01 100644 --- a/src/options/config/flags.rs +++ b/src/options/config/flags.rs @@ -40,7 +40,7 @@ pub(crate) struct FlagConfig { pub(crate) network_use_bytes: Option, pub(crate) network_use_log: Option, pub(crate) network_use_binary_prefix: Option, - pub(crate) enable_gpu: Option, + pub(crate) disable_gpu: Option, pub(crate) enable_cache_memory: Option, pub(crate) retention: Option, pub(crate) average_cpu_row: Option, diff --git a/tests/integration/arg_tests.rs b/tests/integration/arg_tests.rs index 9562e193..72d62747 100644 --- a/tests/integration/arg_tests.rs +++ b/tests/integration/arg_tests.rs @@ -157,11 +157,11 @@ fn test_battery_flag() { #[cfg_attr(feature = "gpu", ignore)] fn test_gpu_flag() { no_cfg_btm_command() - .arg("--enable_gpu") + .arg("--disable_gpu") .assert() .failure() .stderr(predicate::str::contains( - "unexpected argument '--enable_gpu' found", + "unexpected argument '--disable_gpu' found", )); }