sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

ref-manual: Updated KBRANCH variable description. 

I replaced the v3.4 version example with the v3.10 version.
It is more up-to-date.

(From yocto-docs rev: 2e7f5d4fbe24a8248686c9ca7cf870204966beec)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-04-09 09:11:47 -07:00 committed by Richard Purdie
parent bebc72a6ed
commit 7ad0253672
1 changed files with 34 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
documentation/ref-manual/ref-variables.xml
View File

@ -3733,50 +3733,60 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm>
<glossdef>
<para>
A regular expression used by the build process to explicitly identify the kernel
branch that is validated, patched and configured during a build.
A regular expression used by the build process to explicitly
identify the kernel branch that is validated, patched
and configured during a build.
The <filename>KBRANCH</filename> variable is optional.
You can use it to trigger checks to ensure the exact kernel branch you want is
being used by the build process.
You can use it to trigger checks to ensure the exact kernel
branch you want is being used by the build process.
</para>
<para>
Values for this variable are set in the kernel's recipe file and the kernel's
append file.
For example, if you are using the Yocto Project kernel that is based on the
Linux 3.4 kernel, the kernel recipe file is the
<filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> file.
Following is the default value for <filename>KBRANCH</filename> and the default
override for the architectures the Yocto Project supports:
Values for this variable are set in the kernel's recipe
file and the kernel's append file.
For example, if you are using the Yocto Project kernel that
is based on the Linux 3.10 kernel, the kernel recipe file
is the
<filename>meta/recipes-kernel/linux/linux-yocto_3.10.bb</filename>
file.
Following is the default value for <filename>KBRANCH</filename>
and the default override for the architectures the Yocto
Project supports:
<literallayout class='monospaced'>
KBRANCH_DEFAULT = "standard/base"
KBRANCH = "${KBRANCH_DEFAULT}"
</literallayout>
This branch exists in the <filename>linux-yocto-3.4</filename> kernel Git
repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.4/refs/heads'></ulink>.
This branch exists in the <filename>linux-yocto-3.10</filename>
kernel Git repository
<ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.10/refs/heads'></ulink>.
</para>
<para>
This variable is also used from the kernel's append file to identify the kernel
branch specific to a particular machine or target hardware.
The kernel's append file is located in the BSP layer for a given machine.
This variable is also used from the kernel's append file
to identify the kernel branch specific to a particular
machine or target hardware.
The kernel's append file is located in the BSP layer for
a given machine.
For example, the kernel append file for the Crown Bay BSP is in the
<filename>meta-intel</filename> Git repository and is named
<filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend</filename>.
Here are the related statements from the append file:
<literallayout class='monospaced'>
COMPATIBLE_MACHINE_crownbay = "crownbay"
KMACHINE_crownbay = "crownbay"
KBRANCH_crownbay = "standard/crownbay"
KMACHINE_crownbay = "crownbay"
KBRANCH_crownbay = "standard/crownbay"
KERNEL_FEATURES_append_crownbay = " features/drm-emgd/drm-emgd-1.18 cfg/vesafb"
COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd"
KMACHINE_crownbay-noemgd = "crownbay"
KBRANCH_crownbay-noemgd = "standard/crownbay"
KMACHINE_crownbay-noemgd = "crownbay"
KBRANCH_crownbay-noemgd = "standard/crownbay"
KERNEL_FEATURES_append_crownbay-noemgd = " cfg/vesafb"
</literallayout>
The <filename>KBRANCH_*</filename> statements identify the kernel branch to
use when building for the Crown Bay BSP.
In this case there are two identical statements: one for each type of
Crown Bay machine.
The <filename>KBRANCH_*</filename> statements identify
the kernel branch to use when building for the Crown
Bay BSP.
In this case there are two identical statements: one
for each type of Crown Bay machine.
</para>
</glossdef>
</glossentry>