diff options
| author | Eelco Dolstra <edolstra@gmail.com> | 2023-03-27 15:46:18 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-27 15:46:18 +0200 |
| commit | 237587bc0af9259414d50ed18f137c2214d7abb1 (patch) | |
| tree | 98110281567c0e5fb8623065e8172b8559feafb4 /src/libstore/globals.hh | |
| parent | 1d539aa28711b4214867ebd8db85de1000bbbe59 (diff) | |
| parent | 168b6021c558f317fc01b142c1610742e9b9096b (diff) | |
Merge pull request #8084 from edolstra/store-docs
Auto-generate store documentation
Diffstat (limited to 'src/libstore/globals.hh')
| -rw-r--r-- | src/libstore/globals.hh | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/src/libstore/globals.hh b/src/libstore/globals.hh index 09a58afed..299584f99 100644 --- a/src/libstore/globals.hh +++ b/src/libstore/globals.hh @@ -98,7 +98,12 @@ public: Path nixDaemonSocketFile; Setting<std::string> storeUri{this, getEnv("NIX_REMOTE").value_or("auto"), "store", - "The default Nix store to use."}; + R"( + The [URL of the Nix store](@docroot@/command-ref/new-cli/nix3-help-stores.md#store-url-format) + to use for most operations. + See [`nix help-stores`](@docroot@/command-ref/new-cli/nix3-help-stores.md) + for supported store types and settings. + )"}; Setting<bool> keepFailed{this, false, "keep-failed", "Whether to keep temporary directories of failed builds."}; @@ -679,8 +684,9 @@ public: Strings{"https://cache.nixos.org/"}, "substituters", R"( - A list of URLs of substituters, separated by whitespace. Substituters - are tried based on their Priority value, which each substituter can set + A list of [URLs of Nix stores](@docroot@/command-ref/new-cli/nix3-help-stores.md#store-url-format) + to be used as substituters, separated by whitespace. + Substituters are tried based on their Priority value, which each substituter can set independently. Lower value means higher priority. The default is `https://cache.nixos.org`, with a Priority of 40. @@ -698,7 +704,8 @@ public: Setting<StringSet> trustedSubstituters{ this, {}, "trusted-substituters", R"( - A list of URLs of substituters, separated by whitespace. These are + A list of [URLs of Nix stores](@docroot@/command-ref/new-cli/nix3-help-stores.md#store-url-format), + separated by whitespace. These are not used by default, but can be enabled by users of the Nix daemon by specifying `--option substituters urls` on the command line. Unprivileged users are only allowed to pass a subset of the |