From: Alyssa Ross <hi@alyssa.is>
To: devel@spectrum-os.org
Cc: Ville Ilvonen <ville.ilvonen@unikie.com>
Subject: [PATCH] Documentation: clarify value of spectrum-config
Date: Wed, 21 Sep 2022 13:33:41 +0000 [thread overview]
Message-ID: <20220921133341.3120867-1-hi@alyssa.is> (raw)
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
next reply other threads:[~2022-09-21 13:34 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-21 13:33 Alyssa Ross [this message]
2022-09-22 12:33 ` Ville Ilvonen
2022-09-23 12:16 ` Alyssa Ross
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220921133341.3120867-1-hi@alyssa.is \
--to=hi@alyssa.is \
--cc=devel@spectrum-os.org \
--cc=ville.ilvonen@unikie.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://spectrum-os.org/git/crosvm
https://spectrum-os.org/git/doc
https://spectrum-os.org/git/mktuntap
https://spectrum-os.org/git/nixpkgs
https://spectrum-os.org/git/spectrum
https://spectrum-os.org/git/ucspi-vsock
https://spectrum-os.org/git/www
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).