Fixes #234 - Clarify ServerConf documentation

cloudflare · Jun 8, 2024 · d9a37a1 · d9a37a1
1 parent 31d7b63
commit d9a37a1
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/pingora-core/src/server/configuration/mod.rs b/pingora-core/src/server/configuration/mod.rs
@@ -40,9 +40,10 @@ pub struct ServerConf {
     pub version: usize,
     /// Whether to run this process in the background.
     pub daemon: bool,
-    /// When configured, error log will be written to the given file. Otherwise StdErr will be used.
+    /// When configured and `daemon` setting is `true`, error log will be written to the given
+    /// file. Otherwise StdErr will be used.
     pub error_log: Option<String>,
-    /// The pid (process ID) file of this server
+    /// The pid (process ID) file of this server to be created when running in background
     pub pid_file: String,
     /// the path to the upgrade socket
     ///