Repository navigation
doc: fix the logging variable that disables client-side mode - #2969
Merged
Merged
Conversation
sylvestre
reviewed
Oct 29, 2026
| removed. It is currently mutually exclusive with: | ||
|
|
||
| - **error logging** (`SCCACHE_ERROR_LOG`): the client always logs to stderr, and | ||
| - **logging** (`SCCACHE_LOG`): the client always logs to stderr, and |
Collaborator
There was a problem hiding this comment.
maybe make the reason match the new variable? something like:
Suggested change
| - **logging** (`SCCACHE_LOG`): the client always logs to stderr, and | |
| - **logging** (`SCCACHE_LOG`): the client always logs to stderr, ignoring | |
| `SCCACHE_ERROR_LOG`, and multiple concurrent CLI processes would race on the log file, and |
Author
There was a problem hiding this comment.
@sylvestre Thanks! Applied with a small rewording to avoid the double "and"
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2969 +/- ##
==========================================
- Coverage 78.54% 78.54% -0.01%
==========================================
Files 74 74
Lines 44039 44039
==========================================
- Hits 34591 34590 -1
- Misses 9448 9449 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
tiny-ac
force-pushed
the
fix/client-side-logging-docs
branch
from
October 29, 2026 16:17
06171ae to
fb2fed6
Compare
Collaborator
|
Thanks for your PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Configuration.md and Architecture.md say client-side mode is disabled when the
SCCACHE_ERROR_LOGenvironment variable is set, but the code actually checks theSCCACHE_LOGenv variable.SCCACHE_ERROR_LOG is read when the daemon starts to redirect stderr and it's also mentioned in the code comment where the client-side check runs, but the code actually reads LOGGING_ENV, a constant that holds the environment variable name (SCCACHE_LOG).
Ran a compile with a fresh cache and a freshly started server:
SCCACHE_CLIENT_SIDE=1, setting only SCCACHE_ERROR_LOG keeps client-side modesccache --show-statsshowsCompile requests 0SCCACHE_LOG=warnswitches back to server-side modesccache --show-statsshowsCompile requests 1Changes
This PR changes both docs to name SCCACHE_LOG instead of SCCACHE_ERROR_LOG.