update defaults info

raphamorim · Sep 17, 2024 · acc8f28 · acc8f28
1 parent dbaf2cf
commit acc8f28
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 11 deletions.
diff --git a/docs/docs/config/log-level.md → docs/docs/config/developer.md b/docs/docs/config/log-level.md → docs/docs/config/developer.md
@@ -1,5 +1,5 @@
 ---
-title: 'log-level'
+title: 'developer'
 language: 'en'
 ---
 
@@ -8,7 +8,7 @@ This property enables log level filter and file. The default level is "OFF" and
 ```toml
 [developer]
 log-level = "OFF"
-log-file = false
+enable-log-file = false
 ```
 
 If you have any suggestion of configuration ideas to Rio, please feel free to [open an issue](https://github.com/raphamorim/rio/issues/new).
diff --git a/docs/docs/releases.md b/docs/docs/releases.md
@@ -9,6 +9,7 @@ language: 'en'
 
 <!-- - Fix: MacOS Delete key doesn't work in kitty mode [#513](https://github.com/raphamorim/rio/issues/513). -->
 <!-- - Fix: Kitty keyboard protocol doesn't work with tmux [#599](https://github.com/raphamorim/rio/issues/599). -->
+- `developer.log-file` has been renamed to `developer.enable-log-file`.
 - **breaking**: `CollapsedTab` has been renamed to `Bookmark`.
 - Memory usage reduced by 75% (avg ~201mb to 48mb on first screen render).
 - Implemented font data deallocator.

diff --git a/frontends/rioterm/src/cli.rs b/frontends/rioterm/src/cli.rs
@@ -37,7 +37,7 @@ pub struct TerminalOptions {
 
     /// Writes the logs to a file inside the config directory.
     #[clap(long)]
-    pub log_file: bool,
+    pub enable_log_file: bool,
 }
 
 impl TerminalOptions {

diff --git a/frontends/rioterm/src/main.rs b/frontends/rioterm/src/main.rs
@@ -152,10 +152,10 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     };
 
     {
-        let log_to_file = args.window_options.terminal_options.log_file;
+        let log_to_file = args.window_options.terminal_options.enable_log_file;
         if let Err(e) = setup_logs_by_filter_level(
             &config.developer.log_level,
-            log_to_file || config.developer.log_file,
+            log_to_file || config.developer.enable_log_file,
         ) {
             eprintln!("unable to configure the logger: {e:?}");
         }

diff --git a/rio-backend/src/config/defaults.rs b/rio-backend/src/config/defaults.rs
@@ -358,7 +358,7 @@ pub fn default_config_file_content() -> String {
 #
 # "mode" - Define navigation mode
 #   • NativeTab (MacOS only)
-#   • CollapsedTab
+#   • Bookmark
 #   • BottomTab
 #   • TopTab
 #   • Plain
@@ -370,7 +370,7 @@ pub fn default_config_file_content() -> String {
 #
 # Example:
 # [navigation]
-# mode = "collapsedtab"
+# mode = "bookmark"
 # clickable = false
 # hide-if-single = true
 # use-current-path = false
@@ -447,6 +447,6 @@ pub fn default_config_file_content() -> String {
 # Example:
 # [developer]
 # log-level = "OFF"
-# # log-file = "rio.log"
+# enable-log-file = false
 "#.to_string()
 }
diff --git a/rio-backend/src/config/mod.rs b/rio-backend/src/config/mod.rs
@@ -57,15 +57,15 @@ pub struct Developer {
     pub enable_fps_counter: bool,
     #[serde(default = "default_log_level", rename = "log-level")]
     pub log_level: String,
-    #[serde(rename = "log-file", default)]
-    pub log_file: bool,
+    #[serde(rename = "enable-log-file", default)]
+    pub enable_log_file: bool,
 }
 
 impl Default for Developer {
     fn default() -> Developer {
         Developer {
             log_level: default_log_level(),
-            log_file: false,
+            enable_log_file: false,
             enable_fps_counter: false,
         }
     }