From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [PATCH v2 3/3] manuals: add minimum RAM requirements
Date: Fri, 17 Mar 2023 18:31:30 +0100 [thread overview]
Message-ID: <20230317173130.36268-4-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20230317173130.36268-1-michael.opdenacker@bootlin.com>
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
Measured by generating a "core-image-sato" image for a "qemux86-64"
machine from an Ubuntu 22.04 VM with 4 cores.
Less memory was not enough and caused Out of Memory failures.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/brief-yoctoprojectqs/index.rst | 4 ++++
documentation/poky.yaml.in | 2 ++
documentation/ref-manual/system-requirements.rst | 8 ++++++++
3 files changed, 14 insertions(+)
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index 07e95ee85c..0ccffccc60 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -44,6 +44,10 @@ following requirements:
much more will help to run multiple builds and increase
performance by reusing build artifacts.
+- At least &MIN_RAM; Gbytes of RAM, though a modern modern build host with as
+ much RAM and as many CPU cores as possible is strongly recommended to
+ maximize build performance.
+
- Runs a supported Linux distribution (i.e. recent releases of Fedora,
openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux
distributions that support the Yocto Project, see the
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index eefdd3f30d..dc0c257e50 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -45,3 +45,5 @@ MIN_MAKE_VERSION : "4.0"
MIN_DISK_SPACE : "90"
# Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) with "rm_work", rounded up from 38
MIN_DISK_SPACE_RM_WORK : "40"
+# RAM (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) on a 4 core system
+MIN_RAM : "8"
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index bf50fc510a..4fe0cb841b 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -42,6 +42,14 @@ to run multiple builds and to cache build artifacts, improving build efficiency.
If you have a shortage of disk space, see the ":doc:`/dev-manual/disk-space`"
section of the Development Tasks Manual.
+Minimum System RAM
+==================
+
+You will manage to build an image such as ``core-image-sato`` for the
+``qemux86-64`` machine with as little as &MIN_RAM; Gbytes of RAM on an old
+system with 4 CPU cores, but your builds will be much faster on a system with
+as much RAM and as many CPU cores as possible.
+
Supported Linux Distributions
=============================
--
2.34.1
prev parent reply other threads:[~2023-03-17 17:31 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <174D0151E4C65905.10271@lists.yoctoproject.org>
2023-03-17 17:31 ` [PATCH v2 0/3] Update and expand system requirements michael.opdenacker
2023-03-17 17:31 ` [PATCH v2 1/3] manuals: update disk space requirements michael.opdenacker
2023-03-17 17:31 ` [PATCH v2 2/3] manuals: add rm_work disk space data michael.opdenacker
2023-03-17 17:31 ` michael.opdenacker [this message]
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=20230317173130.36268-4-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox