From 7b6b03a1ebb43e737c6feb8700ef679d09302f1d Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Fri, 17 Mar 2023 09:59:20 +0100 Subject: [PATCH] manuals: add minimum RAM requirements 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. (From yocto-docs rev: 5009d3898a1649074d1fc252ed33ecbf3235ed75) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman --- documentation/brief-yoctoprojectqs/index.rst | 4 ++++ documentation/poky.yaml.in | 4 ++++ documentation/ref-manual/system-requirements.rst | 10 ++++++++++ 3 files changed, 18 insertions(+) diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 565e00be2e..462c942961 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst @@ -51,6 +51,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 1d4e176604..8c6549d571 100644 --- a/documentation/poky.yaml.in +++ b/documentation/poky.yaml.in @@ -48,3 +48,7 @@ MIN_GCC_VERSION : "7.5" MIN_MAKE_VERSION : "4.0" # Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64), rounded up from 87 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 72579a5e23..92e2211629 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst @@ -40,6 +40,16 @@ 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. +.. _system-requirements-minimum-ram: + +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. + .. _detailed-supported-distros: Supported Linux Distributions