From 552ff6e3d5f96834e6b3a8881154636dab54a62e Mon Sep 17 00:00:00 2001 From: Alejandro Hernandez Samaniego Date: Wed, 16 Feb 2022 13:17:31 -0700 Subject: documentation: Add multiconfig initramfs configuration: dev-manual/common-tasks.rst: Add section to create an initramfs image from a separate multiconfig. ref-manual/variables.rst: Add new variable definitions for INITRAMFS_DEPLOY_DIR_IMAGE and INITRAMFS_MULTICONFIG (From yocto-docs rev: 7853ab3df82c27ba309879a66a084b2e597dc1e5) Signed-off-by: Alejandro Enedino Hernandez Samaniego Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index d4f40b6929..caa9713935 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3554,6 +3554,13 @@ system and gives an overview of their function and contents. even if the toolchain's binaries are strippable, there are other files needed for the build that are not strippable. + :term:`INITRAMFS_DEPLOY_DIR_IMAGE` + Indicates the deploy directory used by ``do_bundle_initramfs`` where the + :term:`INITRAMFS_IMAGE` will be fetched from. + This variable is set by default to ``${DEPLOY_DIR_IMAGE}`` in the + :ref:`kernel ` class and it's only meant to be changed + when building an initramfs image from a separate multiconfig via :term:`INITRAMFS_MULTICONFIG`. + :term:`INITRAMFS_FSTYPES` Defines the format for the output image of an initial RAM filesystem (initramfs), which is used during boot. Supported formats are the @@ -3673,6 +3680,16 @@ system and gives an overview of their function and contents. See the :term:`MACHINE` variable for additional information. + :term:`INITRAMFS_MULTICONFIG` + Defines the multiconfig to create a multiconfig dependency to be used by the :ref:`kernel ` class. + + This allows the kernel to bundle an :term:`INITRAMFS_IMAGE` coming from + a separate multiconfig, this is meant to be used in addition to :term:`INITRAMFS_DEPLOY_DIR_IMAGE`. + + For more information on how to bundle an initramfs image from a separate + multiconfig see the ":ref:`dev-manual/common-tasks:Bundling an Initramfs Image From a Separate Multiconfig`" + section in the Yocto Project Development Tasks Manual. + :term:`INITRAMFS_NAME` The base name of the initial RAM filesystem image. This variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as -- cgit v1.2.3-54-g00ecf