diff options
| author | Alyssa Ross <alyssa.ross@unikie.com> | 2022-09-21 13:33:41 +0000 |
|---|---|---|
| committer | Alyssa Ross <alyssa.ross@unikie.com> | 2022-09-23 12:13:36 +0000 |
| commit | 0a52864a986adc8c21e9f970dd6c0da9777c48f7 (patch) | |
| tree | 00b92cf1d81e339c209d2557f09ae2d0dcc4765b /Documentation | |
| parent | 3aa2f8aa7423cdf36c797943ad7d5a9756290909 (diff) | |
| download | spectrum-0a52864a986adc8c21e9f970dd6c0da9777c48f7.tar spectrum-0a52864a986adc8c21e9f970dd6c0da9777c48f7.tar.gz spectrum-0a52864a986adc8c21e9f970dd6c0da9777c48f7.tar.bz2 spectrum-0a52864a986adc8c21e9f970dd6c0da9777c48f7.tar.lz spectrum-0a52864a986adc8c21e9f970dd6c0da9777c48f7.tar.xz spectrum-0a52864a986adc8c21e9f970dd6c0da9777c48f7.tar.zst spectrum-0a52864a986adc8c21e9f970dd6c0da9777c48f7.zip | |
Documentation: clarify value of spectrum-config
Before, it was not clear that spectrum-config should be set to a file path, rather than a directory — i.e. whether it override the root of the source tree, or the config.nix path within it. This change clarifies that spectrum-config should be set to a full configuration.nix file path, not the directory that contains it. Reported-by: Ville Ilvonen <ville.ilvonen@unikie.com> Signed-off-by: Alyssa Ross <alyssa.ross@unikie.com> Message-Id: <20220921133341.3120867-1-hi@alyssa.is> Reviewed-by: Ville Ilvonen <ville.ilvonen@unikie.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/build-configuration.adoc | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/build-configuration.adoc b/Documentation/build-configuration.adoc index db68c34..b89575f 100644 --- a/Documentation/build-configuration.adoc +++ b/Documentation/build-configuration.adoc @@ -8,8 +8,9 @@ Some aspects of a Spectrum build can be customised using a build configuration file. By default, this configuration file should be called config.nix and located in the root of the Spectrum source tree, -but this path can be overridden by setting `spectrum-config` in the -https://nixos.org/manual/nix/stable/command-ref/env-common.html#env-NIX_PATH[NIX_PATH]. +but this can be overridden by setting `spectrum-config` in the +https://nixos.org/manual/nix/stable/command-ref/env-common.html#env-NIX_PATH[NIX_PATH] +to the path of the configuration file. The configuration file should contain an attribute set. The only currently allowed attribute name is `pkgs`, which allows using a |