From fb2fed62b2edd8ff1879bedd97ab828aa3d2c655 Mon Sep 17 00:00:00 2001 From: tiny-ac Date: Thu, 29 Oct 2026 10:50:45 -0300 Subject: [PATCH] doc: fix the logging variable that disables client-side mode --- docs/Architecture.md | 4 ++-- docs/Configuration.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Architecture.md b/docs/Architecture.md index 766404317d..07a06437c4 100644 --- a/docs/Architecture.md +++ b/docs/Architecture.md @@ -165,8 +165,8 @@ Client-side mode is enabled with the `SCCACHE_CLIENT_SIDE` environment variable supported configuration in the future, with server-side mode eventually removed. It is currently mutually exclusive with: -- **error logging** (`SCCACHE_ERROR_LOG`): the client always logs to stderr, and - multiple concurrent CLI processes would race on the log file, and +- **logging** (`SCCACHE_LOG`): the client always logs to stderr, ignoring `SCCACHE_ERROR_LOG` + (concurrent CLI processes would race on a shared log file), and - **distributed compilation** (a configured scheduler URL). If either is in use, the setting is ignored and sccache stays in server-side diff --git a/docs/Configuration.md b/docs/Configuration.md index c0bb040870..3e57e99e9f 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -195,7 +195,7 @@ Note that some env variables may need sccache server restart to take effect. * `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 -* `SCCACHE_CLIENT_SIDE` set to `1` to run the compile in the client process and use the daemon only as a gateway to the cache storage (see [the architecture doc](Architecture.md#client-side-mode-sccache_client_side)). This is the recommended mode and is expected to become the only supported configuration in the future. Ignored when `SCCACHE_ERROR_LOG` or distributed compilation is in use. +* `SCCACHE_CLIENT_SIDE` set to `1` to run the compile in the client process and use the daemon only as a gateway to the cache storage (see [the architecture doc](Architecture.md#client-side-mode-sccache_client_side)). This is the recommended mode and is expected to become the only supported configuration in the future. Ignored when `SCCACHE_LOG` or distributed compilation is in use. * `SCCACHE_CACHE_READ_TIMEOUT_SECS` how long, in seconds, a cache lookup may take before sccache gives up on it and compiles locally. Defaults to `60`. A lower value helps when the storage backend is slow or unresponsive rather than failing outright, for example in CI. * `SCCACHE_SKIP_CACHE_CHECK` set to `true`, `on`, or `1` to skip remote cache capability checks. The configured backend `rw_mode` is used without reading or writing `.sccache_check`. The user is responsible for ensuring that the cache is reachable and grants the configured access. * `SCCACHE_CACHE_MULTIARCH` set (to any value, even `0`) to enable caching of builds with several different `-arch` flags, which are not cached by default. See [the caching doc](Caching.md#cc-compiler).