From 1d6c764e21d21683dfbb05d4701b21e551b7df69 Mon Sep 17 00:00:00 2001 From: Gilad Naaman Date: Mon, 6 Mar 2023 16:19:48 +0200 Subject: [PATCH] Clarify docs about units of `SCCACHE_IDLE_TIMEOUT` --- docs/Configuration.md | 2 +- src/server.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index 8dfb01a46..311c688de 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -64,7 +64,7 @@ configuration variables * `SCCACHE_ALLOW_CORE_DUMPS` to enable core dumps by the server * `SCCACHE_CONF` configuration file path * `SCCACHE_CACHED_CONF` -* `SCCACHE_IDLE_TIMEOUT` how long the local daemon process waits for more client requests before exiting. Set to `0` to run sccache permanently +* `SCCACHE_IDLE_TIMEOUT` how long the local daemon process waits for more client requests before exiting, in seconds. Set to `0` to run sccache permanently * `SCCACHE_STARTUP_NOTIFY` specify a path to a socket which will be used for server completion notification * `SCCACHE_MAX_FRAME_LENGTH` how much data can be transferred between client and server * `SCCACHE_NO_DAEMON` set to `1` to disable putting the server to the background diff --git a/src/server.rs b/src/server.rs index 40643d88d..1e1606909 100644 --- a/src/server.rs +++ b/src/server.rs @@ -88,7 +88,7 @@ pub enum ServerStartup { Err { reason: String }, } -/// Get the time the server should idle for before shutting down. +/// Get the time the server should idle for before shutting down, in seconds. fn get_idle_timeout() -> u64 { // A value of 0 disables idle shutdown entirely. env::var("SCCACHE_IDLE_TIMEOUT")