diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-03-17 09:59:20 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-04-03 14:48:47 +0100 |
commit | 88b440af718f45581ea257a7a382fcfde8a9462b (patch) | |
tree | 87ed4aa69aee03112dc388b6f61654f371b85345 /documentation | |
parent | 71b964b0dca60093e643db67c0cf26a75a6c1fcc (diff) | |
download | poky-88b440af718f45581ea257a7a382fcfde8a9462b.tar.gz |
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: a05f87929eed43cef673a8c2581899a8c9ccf462)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 4 | ||||
-rw-r--r-- | documentation/poky.yaml.in | 2 | ||||
-rw-r--r-- | documentation/ref-manual/system-requirements.rst | 8 |
3 files changed, 14 insertions, 0 deletions
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: | |||
44 | much more will help to run multiple builds and increase | 44 | much more will help to run multiple builds and increase |
45 | performance by reusing build artifacts. | 45 | performance by reusing build artifacts. |
46 | 46 | ||
47 | - At least &MIN_RAM; Gbytes of RAM, though a modern modern build host with as | ||
48 | much RAM and as many CPU cores as possible is strongly recommended to | ||
49 | maximize build performance. | ||
50 | |||
47 | - Runs a supported Linux distribution (i.e. recent releases of Fedora, | 51 | - Runs a supported Linux distribution (i.e. recent releases of Fedora, |
48 | openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux | 52 | openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux |
49 | distributions that support the Yocto Project, see the | 53 | 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" | |||
45 | MIN_DISK_SPACE : "90" | 45 | MIN_DISK_SPACE : "90" |
46 | # Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) with "rm_work", rounded up from 38 | 46 | # Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) with "rm_work", rounded up from 38 |
47 | MIN_DISK_SPACE_RM_WORK : "40" | 47 | MIN_DISK_SPACE_RM_WORK : "40" |
48 | # RAM (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) on a 4 core system | ||
49 | 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. | |||
42 | If you have a shortage of disk space, see the ":doc:`/dev-manual/disk-space`" | 42 | If you have a shortage of disk space, see the ":doc:`/dev-manual/disk-space`" |
43 | section of the Development Tasks Manual. | 43 | section of the Development Tasks Manual. |
44 | 44 | ||
45 | Minimum System RAM | ||
46 | ================== | ||
47 | |||
48 | You will manage to build an image such as ``core-image-sato`` for the | ||
49 | ``qemux86-64`` machine with as little as &MIN_RAM; Gbytes of RAM on an old | ||
50 | system with 4 CPU cores, but your builds will be much faster on a system with | ||
51 | as much RAM and as many CPU cores as possible. | ||
52 | |||
45 | Supported Linux Distributions | 53 | Supported Linux Distributions |
46 | ============================= | 54 | ============================= |
47 | 55 | ||