refactor(project): use consistent naming for kernel parameters

systeroid-core/src/sysctl/display.rs

@@ -1,13 +1,13 @@
-/// Possible ways of displaying the kernel variables.
+/// Possible ways of displaying the kernel parameters.
 #[derive(Clone, Debug)]
 pub enum DisplayType {
-    /// Print the kernel variable name along with its value.
+    /// Print the kernel parameter name along with its value.
     Default,
-    /// Print only the name of the variable.
+    /// Print only the name of the parameter.
     Name,
-    /// Print only the value of the variable.
+    /// Print only the value of the parameter.
     Value,
-    /// Print only the value of the variable without new line.
+    /// Print only the value of the parameter without new line.
     Binary,
 }
 

systeroid-core/src/sysctl/mod.rs

@@ -23,6 +23,6 @@ pub const SYSTEM_PRELOAD: &[&str] = &[
     DEFAULT_PRELOAD,
 ];
 
-/// Deprecated variables to skip while listing.
+/// Deprecated parameters to skip while listing.
 /// <https://bugzilla.redhat.com/show_bug.cgi?id=152435>
-pub const DEPRECATED_VARIABLES: &[&str] = &["base_reachable_time", "retrans_time"];
+pub const DEPRECATED_PARAMS: &[&str] = &["base_reachable_time", "retrans_time"];

systeroid/src/app.rs

@@ -7,7 +7,7 @@ use systeroid_core::error::Result;
 use systeroid_core::parsers::KERNEL_DOCS_PATH;
 use systeroid_core::regex::Regex;
 use systeroid_core::sysctl::controller::Sysctl;
-use systeroid_core::sysctl::{DEPRECATED_VARIABLES, SYSTEM_PRELOAD};
+use systeroid_core::sysctl::{DEPRECATED_PARAMS, SYSTEM_PRELOAD};
 use systeroid_parser::globwalk;
 use systeroid_parser::reader;
 
@@ -50,7 +50,7 @@ impl<'a> App<'a> {
                 }
                 if !display_deprecated {
                     if let Some(param_name) = parameter.absolute_name() {
-                        return !DEPRECATED_VARIABLES.contains(&param_name);
+                        return !DEPRECATED_PARAMS.contains(&param_name);
                     }
                 }
                 true
@@ -138,7 +138,7 @@ impl<'a> App<'a> {
         if let Some(new_value) = new_value {
             let config = self.sysctl.config.clone();
             if let Some(param) = self.sysctl.get_parameter(&parameter) {
-                if DEPRECATED_VARIABLES.contains(&param.absolute_name().unwrap_or_default()) {
+                if DEPRECATED_PARAMS.contains(&param.absolute_name().unwrap_or_default()) {
                     eprintln!(
                         "{}: {} is deprecated, value not set",
                         env!("CARGO_PKG_NAME"),

systeroid/src/args.rs

@@ -41,7 +41,7 @@ pub struct Args {
     /// Pattern for matching the variables.
     pub pattern: Option<Regex>,
     /// Whether if the documentation should be shown.
-    pub explain_params: bool,
+    pub explain: bool,
     /// Free string fragments.
     pub values: Vec<String>,
 }
@@ -163,7 +163,7 @@ impl Args {
                 pattern: matches
                     .opt_str("r")
                     .map(|v| Regex::new(&v).expect("invalid regex")),
-                explain_params: matches.opt_present("E"),
+                explain: matches.opt_present("E"),
                 values: matches.free,
             })
         }

systeroid/src/lib.rs

@@ -32,7 +32,7 @@ pub fn run(args: Args) -> Result<()> {
         app.preload_from_system()?;
     } else if args.values.is_empty() {
         app.display_parameters(args.pattern, args.display_deprecated)?;
-    } else if args.explain_params {
+    } else if args.explain {
         app.update_documentation(args.kernel_docs.as_ref())?;
         for param in args.values {
             app.display_documentation(&param)?;