diff options
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 46 |
1 files changed, 26 insertions, 20 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 45fb55eaf4..ff8f4e73d0 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -6479,24 +6479,30 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6479 | <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> | 6479 | <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> |
6480 | name of an image recipe that is used to build an initial | 6480 | name of an image recipe that is used to build an initial |
6481 | RAM filesystem (initramfs) image. | 6481 | RAM filesystem (initramfs) image. |
6482 | An initramfs provides a temporary root filesystem used for | 6482 | In other words, the <filename>INITRAMFS_IMAGE</filename> |
6483 | early system initialization (e.g. loading of modules | 6483 | variable causes an additional recipe to be built as |
6484 | needed to locate and mount the "real" root filesystem). | 6484 | a dependency to whatever root filesystem recipe you |
6485 | The specified recipe is added as a dependency of the root | 6485 | might be using (e.g. <filename>core-image-sato</filename>). |
6486 | filesystem recipe (e.g. | 6486 | The initramfs image recipe you provide should set |
6487 | <filename>core-image-sato</filename>). | 6487 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> |
6488 | See the <filename>meta/recipes-core/images/core-image-minimal-initramfs.bb</filename> | 6488 | to |
6489 | recipe in the | 6489 | <link linkend='var-INITRAMFS_FSTYPES'><filename>INITRAMFS_FSTYPES</filename></link>. |
6490 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 6490 | </para> |
6491 | for an example initramfs recipe. | 6491 | |
6492 | To select this recipe to provide the initramfs, | 6492 | <para> |
6493 | set <filename>INITRAMFS_IMAGE</filename> to | 6493 | An initramfs image provides a temporary root filesystem |
6494 | "core-image-minimal-initramfs". | 6494 | used for early system initialization (e.g. loading of |
6495 | modules needed to locate and mount the "real" root | ||
6496 | filesystem). | ||
6495 | <note> | 6497 | <note> |
6496 | The initramfs image recipe should set | 6498 | See the <filename>meta/recipes-core/images/core-image-minimal-initramfs.bb</filename> |
6497 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> | 6499 | recipe in the |
6498 | to | 6500 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> |
6499 | <link linkend='var-INITRAMFS_FSTYPES'><filename>INITRAMFS_FSTYPES</filename></link>. | 6501 | for an example initramfs recipe. |
6502 | To select this sample recipe as the one bulit | ||
6503 | to provide the initramfs image, | ||
6504 | set <filename>INITRAMFS_IMAGE</filename> to | ||
6505 | "core-image-minimal-initramfs". | ||
6500 | </note> | 6506 | </note> |
6501 | </para> | 6507 | </para> |
6502 | 6508 | ||
@@ -6515,7 +6521,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6515 | 6521 | ||
6516 | <para> | 6522 | <para> |
6517 | If <filename>INITRAMFS_IMAGE</filename> is empty, which is | 6523 | If <filename>INITRAMFS_IMAGE</filename> is empty, which is |
6518 | the default, then no initramfs is built. | 6524 | the default, then no initramfs image is built. |
6519 | </para> | 6525 | </para> |
6520 | 6526 | ||
6521 | <para> | 6527 | <para> |
@@ -6523,8 +6529,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6523 | <link linkend='var-INITRAMFS_IMAGE_BUNDLE'><filename>INITRAMFS_IMAGE_BUNDLE</filename></link> | 6529 | <link linkend='var-INITRAMFS_IMAGE_BUNDLE'><filename>INITRAMFS_IMAGE_BUNDLE</filename></link> |
6524 | variable, which allows the generated image to be bundled | 6530 | variable, which allows the generated image to be bundled |
6525 | inside the kernel image. | 6531 | inside the kernel image. |
6526 | Additionally, for information on creating an initramfs, see | 6532 | Additionally, for information on creating an initramfs |
6527 | the | 6533 | image, see the |
6528 | "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" | 6534 | "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" |
6529 | section in the Yocto Project Development Manual. | 6535 | section in the Yocto Project Development Manual. |
6530 | </para> | 6536 | </para> |