summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/variables.rst30
1 files changed, 27 insertions, 3 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index e22a69b13c..40ff816aca 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4299,9 +4299,33 @@ system and gives an overview of their function and contents.
4299 IMAGE_ROOTFS_EXTRA_SPACE = "41943040" 4299 IMAGE_ROOTFS_EXTRA_SPACE = "41943040"
4300 4300
4301 :term:`IMAGE_ROOTFS_MAXSIZE` 4301 :term:`IMAGE_ROOTFS_MAXSIZE`
4302 Defines the maximum size in Kbytes for the generated image. If the 4302 Defines the maximum allowed size of the generated image in kilobytes.
4303 generated image size is above that, the build will fail. It's a good 4303 The build will fail if the generated image size exceeds this value.
4304 idea to set this variable for images that need to fit on a limited 4304
4305 The generated image size undergoes several calculation steps before being
4306 compared to :term:`IMAGE_ROOTFS_MAXSIZE`.
4307 In the first step, the size of the directory pointed to by :term:`IMAGE_ROOTFS`
4308 is calculated.
4309 In the second step, the result from the first step is multiplied
4310 by :term:`IMAGE_OVERHEAD_FACTOR`.
4311 In the third step, the result from the second step is compared with
4312 :term:`IMAGE_ROOTFS_SIZE`. The larger value of these is added to
4313 :term:`IMAGE_ROOTFS_EXTRA_SPACE`.
4314 In the fourth step, the result from the third step is checked for
4315 a decimal part. If it has one, it is rounded up to the next integer.
4316 If it does not, it is simply converted into an integer.
4317 In the fifth step, the :term:`IMAGE_ROOTFS_ALIGNMENT` is added to the result
4318 from the fourth step and "1" is subtracted.
4319 In the sixth step, the remainder of the division between the result
4320 from the fifth step and :term:`IMAGE_ROOTFS_ALIGNMENT` is subtracted from the
4321 result of the fifth step. In this way, the result from the fourth step is
4322 rounded up to the nearest multiple of :term:`IMAGE_ROOTFS_ALIGNMENT`.
4323
4324 Thus, if the :term:`IMAGE_ROOTFS_MAXSIZE` is set, is compared with the result
4325 of the above calculations and is independent of the final image type.
4326 No default value is set for :term:`IMAGE_ROOTFS_MAXSIZE`.
4327
4328 It's a good idea to set this variable for images that need to fit on a limited
4305 space (e.g. SD card, a fixed-size partition, ...). 4329 space (e.g. SD card, a fixed-size partition, ...).
4306 4330
4307 :term:`IMAGE_ROOTFS_SIZE` 4331 :term:`IMAGE_ROOTFS_SIZE`