diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-03-17 09:59:20 +0100 |
|---|---|---|
| committer | Steve Sakoman <steve@sakoman.com> | 2024-03-01 05:19:55 -1000 |
| commit | 7b6b03a1ebb43e737c6feb8700ef679d09302f1d (patch) | |
| tree | 83a888586e942b3c9fe4002f68a1578b67b90065 /documentation | |
| parent | 64778b45ca53cb7d18c8f094c7bbb96bdc17c95f (diff) | |
| download | poky-7b6b03a1ebb43e737c6feb8700ef679d09302f1d.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: 5009d3898a1649074d1fc252ed33ecbf3235ed75)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 4 | ||||
| -rw-r--r-- | documentation/poky.yaml.in | 4 | ||||
| -rw-r--r-- | documentation/ref-manual/system-requirements.rst | 10 |
3 files changed, 18 insertions, 0 deletions
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: | |||
| 51 | much more will help to run multiple builds and increase | 51 | much more will help to run multiple builds and increase |
| 52 | performance by reusing build artifacts. | 52 | performance by reusing build artifacts. |
| 53 | 53 | ||
| 54 | - At least &MIN_RAM; Gbytes of RAM, though a modern modern build host with as | ||
| 55 | much RAM and as many CPU cores as possible is strongly recommended to | ||
| 56 | maximize build performance. | ||
| 57 | |||
| 54 | - Runs a supported Linux distribution (i.e. recent releases of Fedora, | 58 | - Runs a supported Linux distribution (i.e. recent releases of Fedora, |
| 55 | openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux | 59 | openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux |
| 56 | distributions that support the Yocto Project, see the | 60 | 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" | |||
| 48 | MIN_MAKE_VERSION : "4.0" | 48 | MIN_MAKE_VERSION : "4.0" |
| 49 | # Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64), rounded up from 87 | 49 | # Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64), rounded up from 87 |
| 50 | MIN_DISK_SPACE : "90" | 50 | MIN_DISK_SPACE : "90" |
| 51 | # Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) with "rm_work", rounded up from 38 | ||
| 52 | MIN_DISK_SPACE_RM_WORK : "40" | ||
| 53 | # RAM (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) on a 4 core system | ||
| 54 | 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. | |||
| 40 | If you have a shortage of disk space, see the ":doc:`/dev-manual/disk-space`" | 40 | If you have a shortage of disk space, see the ":doc:`/dev-manual/disk-space`" |
| 41 | section of the Development Tasks Manual. | 41 | section of the Development Tasks Manual. |
| 42 | 42 | ||
| 43 | .. _system-requirements-minimum-ram: | ||
| 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 | |||
| 43 | .. _detailed-supported-distros: | 53 | .. _detailed-supported-distros: |
| 44 | 54 | ||
| 45 | Supported Linux Distributions | 55 | Supported Linux Distributions |
