docs: document debug path config (#669)

Author: gsanchezgavier

super-agent/src/bin/main.rs

@@ -43,8 +43,6 @@ fn main() -> Result<(), Box<dyn Error>> {
 
     #[cfg(debug_assertions)]
     {
-        // Changing default directories if configured in CLI args
-        // Explicit location flags get precedence over the general `debug`
         if let Some(ref local_path) = cli.local_dir {
             defaults::set_local_dir(local_path);
         }

super-agent/src/cli/mod.rs

@@ -13,18 +13,29 @@ pub struct Cli {
     #[arg(long)]
     version: bool,
 
+    /// Overrides the default local configuration path `/etc/newrelic-super-agent/`.
+    /// This config takes precedence over the general `debug`
     #[cfg(debug_assertions)]
     #[arg(long)]
     pub local_dir: Option<PathBuf>,
 
+    /// Overrides the default remote configuration path `/var/lib/newrelic-super-agent`.
+    /// This config takes precedence over the general `debug`
     #[cfg(debug_assertions)]
     #[arg(long)]
     pub remote_dir: Option<PathBuf>,
 
+    /// Overrides the default log path `/var/log/newrelic-super-agent`.
+    /// This config takes precedence over the general `debug`    
     #[cfg(debug_assertions)]
     #[arg(long)]
     pub logs_dir: Option<PathBuf>,
 
+    /// Overrides the default paths used for local/remote configuration and logs to the following
+    /// relatives paths.
+    /// `/etc/newrelic-super-agent/` -> <defined path>/nrsa_local
+    /// `/var/lib/newrelic-super-agent` -> <defined path>/nrsa_remote
+    /// `/var/log/newrelic-super-agent` -> <defined path>/nrsa_logs
     #[cfg(debug_assertions)]
     #[arg(long, value_name = "DATA_DIR")]
     pub debug: Option<PathBuf>,

super-agent/src/super_agent/defaults.rs

@@ -10,6 +10,8 @@ use tracing::debug;
 
 // What does this do?
 // This macro generates a static variable and a function that returns a reference to that variable.
+// This allows to set this variables on initialization, like what is done when using the super-agent
+// `--debug` flag.
 // Given an identifier `SUPER_AGENT_ID` and a value `"super-agent"` of type `&str`, the macro call
 // `generate_const_getter!(SUPER_AGENT_ID, "super-agent")` generates the following:
 //