diff options
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index fbdd3c0850..7cc01c64ef 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -6454,6 +6454,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6454 | </glossdef> | 6454 | </glossdef> |
6455 | </glossentry> | 6455 | </glossentry> |
6456 | 6456 | ||
6457 | <glossentry id='var-KERNEL_ALT_IMAGETYPE'><glossterm>KERNEL_ALT_IMAGETYPE</glossterm> | ||
6458 | <info> | ||
6459 | KERNEL_ALT_IMAGETYPE[doc] = "Specifies an alternate kernel image type for creation." | ||
6460 | </info> | ||
6461 | <glossdef> | ||
6462 | <para role="glossdeffirst"> | ||
6463 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
6464 | Specifies an alternate kernel image type for creation in | ||
6465 | addition to the kernel image type specified using the | ||
6466 | <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> | ||
6467 | variable. | ||
6468 | </para> | ||
6469 | </glossdef> | ||
6470 | </glossentry> | ||
6471 | |||
6457 | <glossentry id='var-KERNEL_CLASSES'><glossterm>KERNEL_CLASSES</glossterm> | 6472 | <glossentry id='var-KERNEL_CLASSES'><glossterm>KERNEL_CLASSES</glossterm> |
6458 | <info> | 6473 | <info> |
6459 | KERNEL_CLASSES[doc] = "A list of classes defining kernel image types that kernel class should inherit." | 6474 | KERNEL_CLASSES[doc] = "A list of classes defining kernel image types that kernel class should inherit." |
@@ -6475,6 +6490,34 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6475 | </glossdef> | 6490 | </glossdef> |
6476 | </glossentry> | 6491 | </glossentry> |
6477 | 6492 | ||
6493 | <glossentry id='var-KERNEL_DEVICETREE'><glossterm>KERNEL_DEVICETREE</glossterm> | ||
6494 | <info> | ||
6495 | KERNEL_DEVICETREE[doc] = "Specifies the name of the generated Linux kernel device tree (i.e. the <filename>.dtb</filename>) file." | ||
6496 | </info> | ||
6497 | <glossdef> | ||
6498 | <para role="glossdeffirst"> | ||
6499 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
6500 | Specifies the name of the generated Linux kernel device tree | ||
6501 | (i.e. the <filename>.dtb</filename>) file. | ||
6502 | <note> | ||
6503 | Legacy support exists for specifying the full path | ||
6504 | to the device tree. | ||
6505 | However, providing just the <filename>.dtb</filename> | ||
6506 | file is preferred. | ||
6507 | </note> | ||
6508 | In order to use this variable, you must have the include | ||
6509 | files in your kernel recipe: | ||
6510 | <literallayout class='monospaced'> | ||
6511 | require recipes-kernel/linux/linux-dtb.inc | ||
6512 | </literallayout> | ||
6513 | or | ||
6514 | <literallayout class='monospaced'> | ||
6515 | require recipes-kernel/linux/linux-yocto.inc | ||
6516 | </literallayout> | ||
6517 | </para> | ||
6518 | </glossdef> | ||
6519 | </glossentry> | ||
6520 | |||
6478 | <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm> | 6521 | <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm> |
6479 | <info> | 6522 | <info> |
6480 | KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build system passes on when compiling the kernel." | 6523 | KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build system passes on when compiling the kernel." |
@@ -6604,6 +6647,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6604 | when building the kernel and is passed to <filename>make</filename> as the target to | 6647 | when building the kernel and is passed to <filename>make</filename> as the target to |
6605 | build. | 6648 | build. |
6606 | </para> | 6649 | </para> |
6650 | |||
6651 | <para> | ||
6652 | If you want to build an alternate kernel image type, use the | ||
6653 | <link linkend='var-KERNEL_ALT_IMAGETYPE'><filename>KERNEL_ALT_IMAGETYPE</filename></link> | ||
6654 | variable. | ||
6655 | </para> | ||
6607 | </glossdef> | 6656 | </glossdef> |
6608 | </glossentry> | 6657 | </glossentry> |
6609 | 6658 | ||
@@ -6742,6 +6791,46 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6742 | </glossdef> | 6791 | </glossdef> |
6743 | </glossentry> | 6792 | </glossentry> |
6744 | 6793 | ||
6794 | <glossentry id='var-KERNEL_VERSION'><glossterm>KERNEL_VERSION</glossterm> | ||
6795 | <info> | ||
6796 | KERNEL_VERSION[doc] = "Specifies the version of the kernel as extracted from version.h or utsrelease.h within the kernel sources." | ||
6797 | </info> | ||
6798 | <glossdef> | ||
6799 | <para role="glossdeffirst"> | ||
6800 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
6801 | Specifies the version of the kernel as extracted from | ||
6802 | <filename>version.h</filename> or | ||
6803 | <filename>utsrelease.h</filename> within the kernel sources. | ||
6804 | Effects of setting this variable do not take affect until | ||
6805 | the kernel has been configured. | ||
6806 | Consequently, attempting to refer to this variable in | ||
6807 | contexts prior to configuration will not work. | ||
6808 | </para> | ||
6809 | </glossdef> | ||
6810 | </glossentry> | ||
6811 | |||
6812 | <glossentry id='var-KERNELDEPMODDEPEND'><glossterm>KERNELDEPMODDEPEND</glossterm> | ||
6813 | <info> | ||
6814 | KERNELDEPMODDEPEND[doc] = "Specifies whether or not to use the data referenced through the PKGDATA_DIR directory." | ||
6815 | </info> | ||
6816 | <glossdef> | ||
6817 | <para role="glossdeffirst"> | ||
6818 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
6819 | Specifies whether the data referenced through | ||
6820 | <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> | ||
6821 | is needed or not. | ||
6822 | The <filename>KERNELDEPMODDEPEND</filename> does not | ||
6823 | control whether or not that data exists, | ||
6824 | but simply whether or not it is used. | ||
6825 | If you do not need to use the data, set the | ||
6826 | <filename>KERNELDEPMODDEPEND</filename> variable in your | ||
6827 | <filename>initramfs</filename> recipe. | ||
6828 | Setting the variable there when the data is not needed | ||
6829 | avoids a potential dependency loop. | ||
6830 | </para> | ||
6831 | </glossdef> | ||
6832 | </glossentry> | ||
6833 | |||
6745 | <glossentry id='var-KFEATURE_DESCRIPTION'><glossterm>KFEATURE_DESCRIPTION</glossterm> | 6834 | <glossentry id='var-KFEATURE_DESCRIPTION'><glossterm>KFEATURE_DESCRIPTION</glossterm> |
6746 | <info> | 6835 | <info> |
6747 | KFEATURE_DESCRIPTION[doc] = "Provides a short description of a configuration fragment. You use this variable in the .scc file that describes a configuration fragment file." | 6836 | KFEATURE_DESCRIPTION[doc] = "Provides a short description of a configuration fragment. You use this variable in the .scc file that describes a configuration fragment file." |
@@ -11735,6 +11824,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
11735 | </glossdef> | 11824 | </glossdef> |
11736 | </glossentry> | 11825 | </glossentry> |
11737 | 11826 | ||
11827 | <glossentry id='var-STAGING_KERNEL_BUILDDIR'><glossterm>STAGING_KERNEL_BUILDDIR</glossterm> | ||
11828 | <info> | ||
11829 | STAGING_KERNEL_BUILDDIR[doc] = "Points to the directory containing the kernel build artifacts." | ||
11830 | </info> | ||
11831 | <glossdef> | ||
11832 | <para role="glossdeffirst"> | ||
11833 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
11834 | Points to the directory containing the kernel build | ||
11835 | artifacts. | ||
11836 | Recipes building software that needs to access kernel | ||
11837 | build artifacts | ||
11838 | (e.g. <filename>systemtap-uprobes</filename>) can look in | ||
11839 | the directory specified with the | ||
11840 | <filename>STAGING_KERNEL_BUILDDIR</filename> variable to | ||
11841 | find these artifacts after the kernel has been built. | ||
11842 | </para> | ||
11843 | </glossdef> | ||
11844 | </glossentry> | ||
11845 | |||
11738 | <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> | 11846 | <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> |
11739 | <info> | 11847 | <info> |
11740 | STAGING_KERNEL_DIR[doc] = "The directory with kernel headers that are required to build out-of-tree modules." | 11848 | STAGING_KERNEL_DIR[doc] = "The directory with kernel headers that are required to build out-of-tree modules." |