aboutsummaryrefslogtreecommitdiff
path: root/src/libstore/globals.hh
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2023-03-21 14:37:09 +0100
committerEelco Dolstra <edolstra@gmail.com>2023-03-21 14:37:09 +0100
commit233b063b08b6a82921d26fb5a86e15c2b94a72ee (patch)
treebc3ba348b15da8215f6bdb149f6c9de77caef77d /src/libstore/globals.hh
parent3fc4659d22fc3c8cfbffd7322fd6c034efaaa3ab (diff)
Move store docs to 'nix help-stores'
Why not 'nix help stores'? Well, 'nix help <arg>' already means 'show help on the "arg" subcommand'.
Diffstat (limited to 'src/libstore/globals.hh')
-rw-r--r--src/libstore/globals.hh5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/libstore/globals.hh b/src/libstore/globals.hh
index 93086eaf8..4382d1b85 100644
--- a/src/libstore/globals.hh
+++ b/src/libstore/globals.hh
@@ -97,7 +97,10 @@ 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 to use. 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."};