diff options
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r-- | documentation/ref-manual/variables.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 4610add7ea..bad400586a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -3617,6 +3617,36 @@ system and gives an overview of their function and contents. | |||
3617 | 3617 | ||
3618 | IMAGE_ROOTFS_EXTRA_SPACE = "41943040" | 3618 | IMAGE_ROOTFS_EXTRA_SPACE = "41943040" |
3619 | 3619 | ||
3620 | :term:`IMAGE_ROOTFS_MAXSIZE` | ||
3621 | Defines the maximum allowed size of the generated image in kilobytes. | ||
3622 | The build will fail if the generated image size exceeds this value. | ||
3623 | |||
3624 | The generated image size undergoes several calculation steps before being | ||
3625 | compared to :term:`IMAGE_ROOTFS_MAXSIZE`. | ||
3626 | In the first step, the size of the directory pointed to by :term:`IMAGE_ROOTFS` | ||
3627 | is calculated. | ||
3628 | In the second step, the result from the first step is multiplied | ||
3629 | by :term:`IMAGE_OVERHEAD_FACTOR`. | ||
3630 | In the third step, the result from the second step is compared with | ||
3631 | :term:`IMAGE_ROOTFS_SIZE`. The larger value of these is added to | ||
3632 | :term:`IMAGE_ROOTFS_EXTRA_SPACE`. | ||
3633 | In the fourth step, the result from the third step is checked for | ||
3634 | a decimal part. If it has one, it is rounded up to the next integer. | ||
3635 | If it does not, it is simply converted into an integer. | ||
3636 | In the fifth step, the :term:`IMAGE_ROOTFS_ALIGNMENT` is added to the result | ||
3637 | from the fourth step and "1" is subtracted. | ||
3638 | In the sixth step, the remainder of the division between the result | ||
3639 | from the fifth step and :term:`IMAGE_ROOTFS_ALIGNMENT` is subtracted from the | ||
3640 | result of the fifth step. In this way, the result from the fourth step is | ||
3641 | rounded up to the nearest multiple of :term:`IMAGE_ROOTFS_ALIGNMENT`. | ||
3642 | |||
3643 | Thus, if the :term:`IMAGE_ROOTFS_MAXSIZE` is set, is compared with the result | ||
3644 | of the above calculations and is independent of the final image type. | ||
3645 | No default value is set for :term:`IMAGE_ROOTFS_MAXSIZE`. | ||
3646 | |||
3647 | It's a good idea to set this variable for images that need to fit on a limited | ||
3648 | space (e.g. SD card, a fixed-size partition, ...). | ||
3649 | |||
3620 | :term:`IMAGE_ROOTFS_SIZE` | 3650 | :term:`IMAGE_ROOTFS_SIZE` |
3621 | Defines the size in Kbytes for the generated image. The OpenEmbedded | 3651 | Defines the size in Kbytes for the generated image. The OpenEmbedded |
3622 | build system determines the final size for the generated image using | 3652 | build system determines the final size for the generated image using |