[PATCH] 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 <hi@alyssa.is> --- Documentation/build-configuration.adoc | 5 +++-- 1 file 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 -- 2.37.1
On 9/21/22 16:33, Alyssa Ross wrote:
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.
Thanks, got it working with your clarification on #spectrum My 2 cents for example newer hurts, like adding: export NIX_PATH=$NIX_PATH:spectrum-config=$(pwd)/path/to/config.nix Also, outside the scope of this review - changing the default x86 build to use the build config.nix structure and work as reference would be nice development and help further board enabled / architecture porting effort as board-specific configs are preferred out-of-tree. Best, -Ville Reviewed-by: Ville Ilvonen <ville.ilvonen@unikie.com>
Reported-by: Ville Ilvonen <ville.ilvonen@unikie.com> Signed-off-by: Alyssa Ross <hi@alyssa.is> --- Documentation/build-configuration.adoc | 5 +++-- 1 file 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
This patch has been committed as 0a52864a986adc8c21e9f970dd6c0da9777c48f7, which can be viewed online at https://spectrum-os.org/git/spectrum/commit/?id=0a52864a986adc8c21e9f970dd6c.... This is an automated message. Send comments/questions/requests to: Alyssa Ross <hi@alyssa.is>
participants (3)
-
Alyssa Ross -
Alyssa Ross -
Ville Ilvonen