diff options
| -rw-r--r-- | documentation/kernel-dev/kernel-dev-advanced.xml | 28 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 5 |
2 files changed, 19 insertions, 14 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml index 785076026d..9b35a422db 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.xml +++ b/documentation/kernel-dev/kernel-dev-advanced.xml | |||
| @@ -24,9 +24,9 @@ | |||
| 24 | <title>Using Kernel Metadata in a Recipe</title> | 24 | <title>Using Kernel Metadata in a Recipe</title> |
| 25 | 25 | ||
| 26 | <para> | 26 | <para> |
| 27 | The kernel sources in the Yocto Project contain kernel Metadata, which is | 27 | The kernel sources in the Yocto Project contain kernel Metadata, which |
| 28 | located in the <filename>meta</filename> branches of the kernel source | 28 | is located in the <filename>meta</filename> branches of the kernel |
| 29 | Git repositories. | 29 | source Git repositories. |
| 30 | This Metadata defines Board Support Packages (BSPs) that | 30 | This Metadata defines Board Support Packages (BSPs) that |
| 31 | correspond to definitions in linux-yocto recipes for the same BSPs. | 31 | correspond to definitions in linux-yocto recipes for the same BSPs. |
| 32 | A BSP consists of an aggregation of kernel policy and hardware-specific | 32 | A BSP consists of an aggregation of kernel policy and hardware-specific |
| @@ -61,20 +61,26 @@ | |||
| 61 | </para> | 61 | </para> |
| 62 | 62 | ||
| 63 | <para> | 63 | <para> |
| 64 | Every linux-yocto style recipe must also indicate the Linux kernel | ||
| 65 | source repository branch used to build the Linux kernel. | ||
| 66 | The <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'>KBRANCH</ulink> | ||
| 67 | variable must be set to indicate the branch. | ||
| 68 | <note> | ||
| 69 | You can use the <filename>KBRANCH</filename> value to define an | ||
| 70 | alternate branch typically with a machine override as follows: | ||
| 71 | <literallayout class='monospaced'> | ||
| 72 | KBRANCH_fri2 ?= "standard/fri2" | ||
| 73 | </literallayout> | ||
| 74 | </note> | ||
| 75 | </para> | ||
| 76 | |||
| 77 | <para> | ||
| 64 | The linux-yocto style recipes can optionally define the following | 78 | The linux-yocto style recipes can optionally define the following |
| 65 | variables: | 79 | variables: |
| 66 | <literallayout class='monospaced'> | 80 | <literallayout class='monospaced'> |
| 67 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'>KBRANCH</ulink> | ||
| 68 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'>KERNEL_FEATURES</ulink> | 81 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'>KERNEL_FEATURES</ulink> |
| 69 | <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</ulink> | 82 | <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</ulink> |
| 70 | </literallayout> | 83 | </literallayout> |
| 71 | <filename>KBRANCH</filename> defines the Linux kernel source | ||
| 72 | repository's branch to use to build the Linux kernel. | ||
| 73 | You can use the value to define an alternate branch typically with a | ||
| 74 | machine override as follows: | ||
| 75 | <literallayout class='monospaced'> | ||
| 76 | KBRANCH_fri2 ?= "standard/fri2" | ||
| 77 | </literallayout> | ||
| 78 | </para> | 84 | </para> |
| 79 | 85 | ||
| 80 | <para> | 86 | <para> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 6bcbbb316f..98799d5c95 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
| @@ -5758,10 +5758,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 5758 | <glossdef> | 5758 | <glossdef> |
| 5759 | <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> | 5759 | <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> |
| 5760 | A regular expression used by the build process to explicitly | 5760 | A regular expression used by the build process to explicitly |
| 5761 | identify the kernel branch that is validated, patched | 5761 | identify the kernel branch that is validated, patched, |
| 5762 | and configured during a build. | 5762 | and configured during a build. |
| 5763 | The <filename>KBRANCH</filename> variable is optional. | 5763 | You must set this variable to ensure the exact kernel |
| 5764 | You can use it to trigger checks to ensure the exact kernel | ||
| 5765 | branch you want is being used by the build process. | 5764 | branch you want is being used by the build process. |
| 5766 | </para> | 5765 | </para> |
| 5767 | 5766 | ||
