From d9a37a1f38e8369d1b1eae28d67624d7e54e8738 Mon Sep 17 00:00:00 2001 From: Wladimir Palant <374261+palant@users.noreply.github.com> Date: Sat, 8 Jun 2024 22:13:20 +0200 Subject: [PATCH] Fixes #234 - Clarify `ServerConf` documentation --- pingora-core/src/server/configuration/mod.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pingora-core/src/server/configuration/mod.rs b/pingora-core/src/server/configuration/mod.rs index a4b5cc732..c118c84ac 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, - /// 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 ///