summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-03-16 18:34:53 +0100
committerSteve Sakoman <steve@sakoman.com>2024-03-01 05:19:55 -1000
commit64778b45ca53cb7d18c8f094c7bbb96bdc17c95f (patch)
tree27c5a545a62fb6f017bd26be4a6cafcfdd34f6fb /documentation
parentf59e2c869cd8918447d9fce7d1db69c1bdddc4dd (diff)
downloadpoky-64778b45ca53cb7d18c8f094c7bbb96bdc17c95f.tar.gz
manuals: update disk space requirements
Tests made on Poky master on March 16, 2023. Add a "Free Disk Space" section to the "System Requirements" document. (From yocto-docs rev: 6e88a53c47f15376c4eec8b34d14239dcf285da3) 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.rst4
-rw-r--r--documentation/poky.yaml.in2
-rw-r--r--documentation/ref-manual/system-requirements.rst11
3 files changed, 16 insertions, 1 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index ec4cc8b051..565e00be2e 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -47,7 +47,9 @@ Compatible Linux Distribution
47Make sure your :term:`Build Host` meets the 47Make sure your :term:`Build Host` meets the
48following requirements: 48following requirements:
49 49
50- 50 Gbytes of free disk space 50- At least &MIN_DISK_SPACE; Gbytes of free disk space, though
51 much more will help to run multiple builds and increase
52 performance by reusing build artifacts.
51 53
52- Runs a supported Linux distribution (i.e. recent releases of Fedora, 54- Runs a supported Linux distribution (i.e. recent releases of Fedora,
53 openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux 55 openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index 6b942f0959..1d4e176604 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -46,3 +46,5 @@ MIN_TAR_VERSION : "1.28"
46MIN_GIT_VERSION : "1.8.3.1" 46MIN_GIT_VERSION : "1.8.3.1"
47MIN_GCC_VERSION : "7.5" 47MIN_GCC_VERSION : "7.5"
48MIN_MAKE_VERSION : "4.0" 48MIN_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
50MIN_DISK_SPACE : "90"
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 274781a903..72579a5e23 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -29,6 +29,17 @@ and conceptual information in the :doc:`/overview-manual/index`.
29 For more information about the Yocto Project Documentation set, see 29 For more information about the Yocto Project Documentation set, see
30 the :ref:`ref-manual/resources:links and related documentation` section. 30 the :ref:`ref-manual/resources:links and related documentation` section.
31 31
32Minimum Free Disk Space
33=======================
34
35To build an image such as ``core-image-sato`` for the ``qemux86-64`` machine,
36you need a system with at least &MIN_DISK_SPACE; Gbytes of free disk space.
37However, much more disk space will be necessary to build more complex images,
38to run multiple builds and to cache build artifacts, improving build efficiency.
39
40If you have a shortage of disk space, see the ":doc:`/dev-manual/disk-space`"
41section of the Development Tasks Manual.
42
32.. _detailed-supported-distros: 43.. _detailed-supported-distros:
33 44
34Supported Linux Distributions 45Supported Linux Distributions