Skip to content

Commit aba39c5

Browse files
committed
docs(cli): name the update cache path for relocated config dirs
Review round 3. The cache is derived from `configDir()`, so it moves with `SIM_CONFIG_DIR` like the config and credentials files do - but the docs named only the `~/.sim` default, sending anyone with a relocated config dir to a file that is not there.
1 parent 1d4e7f5 commit aba39c5

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

apps/docs/content/docs/cli/configuration.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,13 @@ The notice is skipped entirely when:
155155
deliberately trails the published one
156156
- the installed version is a prerelease from the `staging` or `dev` channel
157157

158-
The once-a-day pace comes from a timestamp in `~/.sim/update-check.json`. If
159-
that file cannot be written — a read-only home in a container, or a `~/.sim`
160-
left root-owned by an earlier `sudo` install — the pace cannot be remembered,
161-
so the check runs once per command instead of once per day. It stays bounded by
162-
the same one-second timeout, and `SIM_NO_UPDATE_CHECK=1` still turns it off.
158+
The once-a-day pace comes from a timestamp in `update-check.json`, kept beside
159+
the config and credentials files: `~/.sim/update-check.json` by default, and
160+
under `SIM_CONFIG_DIR` when that is set. If it cannot be written — a read-only
161+
home in a container, or a `~/.sim` left root-owned by an earlier `sudo` install
162+
— the pace cannot be remembered, so the check runs once per command instead of
163+
once per day. It stays bounded by the same one-second timeout, and
164+
`SIM_NO_UPDATE_CHECK=1` still turns it off.
163165

164166
Set `npm_config_registry` to ask a mirror instead; its path and query are
165167
preserved, so a token-authenticated Artifactory or Nexus base works.

0 commit comments

Comments
 (0)