patches and low-level development discussion
 help / color / mirror / code / Atom feed
From: Alyssa Ross <hi@alyssa.is>
To: devel@spectrum-os.org
Subject: [PATCH] Documentation: explain Nix using too many cores
Date: Sun, 29 Sep 2024 20:24:10 +0200	[thread overview]
Message-ID: <20240929182410.2528178-1-hi@alyssa.is> (raw)

This is confusing to people, and will be especially so if Spectrum is
the first big Nix build they've done, which is not unlikely.

Signed-off-by: Alyssa Ross <hi@alyssa.is>
---
 Documentation/installation/getting-spectrum.adoc | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/Documentation/installation/getting-spectrum.adoc b/Documentation/installation/getting-spectrum.adoc
index 3620c79..29803aa 100644
--- a/Documentation/installation/getting-spectrum.adoc
+++ b/Documentation/installation/getting-spectrum.adoc
@@ -2,7 +2,7 @@
 :page-parent: Build and Run
 :page-nav_order: 2
 
-// SPDX-FileCopyrightText: 2022-2023 Alyssa Ross <hi@alyssa.is>
+// SPDX-FileCopyrightText: 2022-2024 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
 
 To get Spectrum, you need to build it from source.  As long as you're
@@ -16,6 +16,13 @@ TIP: Before you start, consider setting up the
 xref:binary-cache.adoc[Spectrum binary cache], which will save you a
 lot of time waiting for builds.
 
+TIP: If you encounter build failures, especially timeouts or
+out-of-memory (OOM) kills, Nix might be configured to run too many
+builds at once, with too many cores per build.  See Nix's
+documentation for
+https://nix.dev/manual/nix/2.24/advanced-topics/cores-vs-jobs.html[tuning
+cores and jobs].
+
 == Trying Spectrum
 
 If you want to try Spectrum out to get a feel for it, without

base-commit: 6e9c1f7967a44206e8f70d1d20e0f4e71987bed8
-- 
2.45.2


                 reply	other threads:[~2024-09-29 18:24 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20240929182410.2528178-1-hi@alyssa.is \
    --to=hi@alyssa.is \
    --cc=devel@spectrum-os.org \
    /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).