aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorWladimir Palant <[email protected]>2024-06-08 20:13:20 +0000
committerMatthew (mbg) <[email protected]>2024-06-21 09:54:09 -0700
commit05005e2a4d1598fed4640f5abe930217d58ebbd3 (patch)
tree807892c91a49a4833e441b5da55de878da7845e9
parentc943fc1c78fa3d429610b290f7b59fd485ac1de4 (diff)
downloadpingora-05005e2a4d1598fed4640f5abe930217d58ebbd3.tar.gz
pingora-05005e2a4d1598fed4640f5abe930217d58ebbd3.zip
Fixes #234 - Clarify `ServerConf` documentation
Includes-commit: d9a37a1f38e8369d1b1eae28d67624d7e54e8738 Replicated-from: https://github.com/cloudflare/pingora/pull/273
-rw-r--r--.bleep2
-rw-r--r--pingora-core/src/server/configuration/mod.rs5
2 files changed, 4 insertions, 3 deletions
diff --git a/.bleep b/.bleep
index 4a1803c..84aa635 100644
--- a/.bleep
+++ b/.bleep
@@ -1 +1 @@
-9392462069291836a53077efe479d3aa9f2072bb \ No newline at end of file
+f70d8b77a4085cbe11b9559317f6d6e7e49914db \ No newline at end of file
diff --git a/pingora-core/src/server/configuration/mod.rs b/pingora-core/src/server/configuration/mod.rs
index a4b5cc7..c118c84 100644
--- 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
///