patches and low-level development discussion
 help / color / mirror / code / Atom feed
From: Alyssa Ross <hi@alyssa.is>
To: devel@spectrum-os.org
Cc: "José Pekkarinen" <jose.pekkarinen@unikie.com>,
	"Ivan Nikolaenko" <ivan.nikolaenko@unikie.com>,
	"Evgeniia Nikolaenko" <evgeniia.nikolaenko@unikie.com>
Subject: [PATCH 4/4] Documentation: document build configuration file
Date: Wed, 31 Aug 2022 09:37:27 +0000	[thread overview]
Message-ID: <20220831093727.282797-4-hi@alyssa.is> (raw)
In-Reply-To: <20220831093727.282797-1-hi@alyssa.is>

Signed-off-by: Alyssa Ross <hi@alyssa.is>
---

There's some documentation on reviewing patches for Spectrum here: :)
https://spectrum-os.org/doc/reviewing-patches.html

 Documentation/build-configuration.adoc | 35 ++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 Documentation/build-configuration.adoc

diff --git a/Documentation/build-configuration.adoc b/Documentation/build-configuration.adoc
new file mode 100644
index 0000000..db68c34
--- /dev/null
+++ b/Documentation/build-configuration.adoc
@@ -0,0 +1,35 @@
+= Configuring the Build
+:page-parent: How-to Guides
+:example-caption: Test
+
+// SPDX-FileCopyrightText: 2022 Unikie
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+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].
+
+The configuration file should contain an attribute set.  The only
+currently allowed attribute name is `pkgs`, which allows using a
+custom Nixpkgs to evaluate Spectrum.
+
+.config.nix to build Spectrum with a https://nixos.org/manual/nixpkgs/unstable/#sec-overlays-definition[Nixpkgs overlay]
+[example]
+[source,nix]
+----
+{
+  pkgs = import <nixpkgs> {
+    overlays = [
+      (final: super: {
+        weston = super.weston.overrideAttrs ({ patches ? [], ... }: {
+          patches = patches ++ [
+            path/to/weston.patch
+          ];
+        });
+      })
+    ];
+  };
+}
+----
-- 
2.37.1



  parent reply	other threads:[~2022-08-31  9:38 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-31  9:37 [PATCH 1/4] Introduce a build configuration file Alyssa Ross
2022-08-31  9:37 ` [PATCH 2/4] nix: prefer build configs from <spectrum-config> Alyssa Ross
2022-09-08 11:40   ` José Pekkarinen
2022-09-14  6:58   ` Alyssa Ross
2022-08-31  9:37 ` [PATCH 3/4] Documentation/jekyll: patch for AsciiDoc examples Alyssa Ross
2022-09-14  7:03   ` Alyssa Ross
2022-08-31  9:37 ` Alyssa Ross [this message]
2022-09-14  6:58   ` [PATCH 4/4] Documentation: document build configuration file Alyssa Ross
2022-09-06  5:53 ` [PATCH 1/4] Introduce a " Ville Ilvonen
     [not found]   ` <87fsh5c60x.fsf@alyssa.is>
2022-09-08 11:39     ` José Pekkarinen
2022-09-14  6:58 ` 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=20220831093727.282797-4-hi@alyssa.is \
    --to=hi@alyssa.is \
    --cc=devel@spectrum-os.org \
    --cc=evgeniia.nikolaenko@unikie.com \
    --cc=ivan.nikolaenko@unikie.com \
    --cc=jose.pekkarinen@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).