From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on atuin.qyliss.net X-Spam-Level: X-Spam-Status: No, score=-4.6 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL,SPF_HELO_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 Received: from atuin.qyliss.net (localhost [IPv6:::1]) by atuin.qyliss.net (Postfix) with ESMTP id 3B1C256416; Wed, 31 Aug 2022 09:38:16 +0000 (UTC) Received: by atuin.qyliss.net (Postfix, from userid 496) id 98312563E4; Wed, 31 Aug 2022 09:38:12 +0000 (UTC) Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by atuin.qyliss.net (Postfix) with ESMTPS id C1C9C563DF for ; Wed, 31 Aug 2022 09:38:08 +0000 (UTC) Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailout.nyi.internal (Postfix) with ESMTP id 898B15C01BB; Wed, 31 Aug 2022 05:38:07 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Wed, 31 Aug 2022 05:38:07 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=alyssa.is; h=cc :cc:content-transfer-encoding:date:date:from:from:in-reply-to :in-reply-to:message-id:mime-version:references:reply-to:sender :subject:subject:to:to; s=fm3; t=1661938687; x=1662025087; bh=Hk 8mTLVuPffrK2h7d9LCWYAiykkHy8qGN9G5cv84+D8=; b=NghhUhRrzNAixvnyDh csQrIx91KaCLiueL/Fcn0Z5snWwPHCXJM32Gm5BLuuxDS74WSAYPVKwDjKCeK1Yy 1UBCVqrr0sp0ekcipoTCCPKsVBEaf/gDyCDGk6HBq6yYFiX6RvE8UazIPfiy03mU kpkAXBJRPAZHeCQSWqYmRp7vlybxIMSie5h7tM9PIyutMawf6DFUPaV1Bbp/IqLy 0D6KGM824ykIph+EEKdNtD/v3doE1BHsdAcFBLHqacvfSaagpcO0jJGyUMpGK6yV +VesMOHRff+FNKRhwyjc4X+5x/bj1XuNE8SN5ZONOmI24RLvwIYtP/7X/uNdLTVD 1j5w== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:sender:subject :subject:to:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; t=1661938687; x=1662025087; bh=Hk8mTLVuPffrK 2h7d9LCWYAiykkHy8qGN9G5cv84+D8=; b=Uorf4MxwLTg89EtyGq0L6+4vyszBb I9AwpYZRqY6eQK5avUSf6UMwogwt27Jp9u9t4g9i4bS56YxWJLoUd+zDb31qAJDP i8SmL86fan5EpZLo8BkbgoCGaSA2ixh8vQEurYglkcz/lOaelpBTDt3ooG01pt/L CeuIR3dNyeWGotTlP+WNnu5OBIIpAKWklxhKdSuiuHgQU7xG0VyzpuyUog50OBMV MoAQEte/rcgwUPGFUGct8o4opXtvGW2QDi+y3HsBYU0xqC7cvYBc6WGqECiuA9eF GVzb1LTSryW1RbvNuTa1/R1WRbjcbxRx2h6CXegV9vliWJ3bKRjD3MKpA== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedrvdekhedgudelucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvvefufffkofgjfhgggfestdekredtredttdenucfhrhhomheptehlhihs shgrucftohhsshcuoehhihesrghlhihsshgrrdhisheqnecuggftrfgrthhtvghrnhepgf ekffefgeehtddtkedtgeejueeitedttdefveelffehtedtkeeffeffueffjeetnecuffho mhgrihhnpehsphgvtghtrhhumhdqohhsrdhorhhgpdhnihigohhsrdhorhhgnecuvehluh hsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepqhihlhhishhsseig vddvtddrqhihlhhishhsrdhnvght X-ME-Proxy: Feedback-ID: i12284293:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 31 Aug 2022 05:38:05 -0400 (EDT) Received: by x220.qyliss.net (Postfix, from userid 1000) id C1D726EC; Wed, 31 Aug 2022 09:37:55 +0000 (UTC) From: Alyssa Ross To: devel@spectrum-os.org Subject: [PATCH 4/4] Documentation: document build configuration file Date: Wed, 31 Aug 2022 09:37:27 +0000 Message-Id: <20220831093727.282797-4-hi@alyssa.is> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20220831093727.282797-1-hi@alyssa.is> References: <20220831093727.282797-1-hi@alyssa.is> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Message-ID-Hash: VXAXK7RRUFQDOUJQMBRQLI2M5I6E6V6P X-Message-ID-Hash: VXAXK7RRUFQDOUJQMBRQLI2M5I6E6V6P X-MailFrom: qyliss@x220.qyliss.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-devel.spectrum-os.org-0; header-match-devel.spectrum-os.org-1; header-match-devel.spectrum-os.org-2; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: =?UTF-8?q?Jos=C3=A9=20Pekkarinen?= , Ivan Nikolaenko , Evgeniia Nikolaenko X-Mailman-Version: 3.3.5 Precedence: list List-Id: Patches and low-level development discussion Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Signed-off-by: Alyssa Ross --- 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 { + overlays = [ + (final: super: { + weston = super.weston.overrideAttrs ({ patches ? [], ... }: { + patches = patches ++ [ + path/to/weston.patch + ]; + }); + }) + ]; + }; +} +---- -- 2.37.1