summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-07-13 08:30:04 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-07-17 10:54:08 +0100
commit582e29ea09a5a5f82107155bef052f6ddae21781 (patch)
tree19cacf30c74a3f4825b19b3ac9fd7a8f3f75d9c4 /documentation/poky-ref-manual/ref-variables.xml
parentd4d48430789916464f74aa42f8bcb47bee8644fa (diff)
downloadpoky-582e29ea09a5a5f82107155bef052f6ddae21781.tar.gz
documentation/poky-ref-manual/ref-variables.xml: Added KBRANCH entry
New finalized entry for KBRANCH. Reviewed by Bruce Ashfield. (From yocto-docs rev: 566e112d20ebe91a1302263b96254f6f66462aaf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual/ref-variables.xml')
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml57
1 files changed, 56 insertions, 1 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index db9d7370f4..6807c5c309 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -26,7 +26,7 @@
26 <link linkend='var-HOMEPAGE'>H</link> 26 <link linkend='var-HOMEPAGE'>H</link>
27 <link linkend='var-IMAGE_FEATURES'>I</link> 27 <link linkend='var-IMAGE_FEATURES'>I</link>
28<!-- <link linkend='var-glossary-j'>J</link> --> 28<!-- <link linkend='var-glossary-j'>J</link> -->
29 <link linkend='var-KERNEL_FEATURES'>K</link> 29 <link linkend='var-KBRANCH'>K</link>
30 <link linkend='var-LAYERDIR'>L</link> 30 <link linkend='var-LAYERDIR'>L</link>
31 <link linkend='var-MACHINE'>M</link> 31 <link linkend='var-MACHINE'>M</link>
32<!-- <link linkend='var-glossary-n'>N</link> --> 32<!-- <link linkend='var-glossary-n'>N</link> -->
@@ -1035,6 +1035,61 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
1035 1035
1036 <glossdiv id='var-glossary-k'><title>K</title> 1036 <glossdiv id='var-glossary-k'><title>K</title>
1037 1037
1038 <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm>
1039 <glossdef>
1040 <para>
1041 A regular expression used by the build process to explicitly identify the kernel
1042 branch that is validated, patched and configured during a build.
1043 The <filename>KBRANCH</filename> variable is optional.
1044 You can use it to trigger checks to ensure the exact kernel branch you want is
1045 being used by the build process.
1046 </para>
1047
1048 <para>
1049 Values for this variable are set in the kernel's recipe file and the kernel's
1050 append file.
1051 For example, if you are using the Yocto Project kernel that is based on the
1052 Linux 3.2 kernel, the kernel recipe file is the
1053 <filename>meta/recipes-kernel/linux/linux-yocto_3.2.bb</filename> file.
1054 Following is the default value for <filename>KBRANCH</filename> and the five overrides
1055 for the architectures the Yocto Project supports:
1056 <literallayout class='monospaced'>
1057 KBRANCH = "standard/default/base"
1058 KBRANCH_qemux86 = "standard/default/common-pc/base"
1059 KBRANCH_qemux86-64 = "standard/default/common-pc-64/base"
1060 KBRANCH_qemuppc = "standard/default/qemu-ppc32"
1061 KBRANCH_qemumips = "standard/default/mti-malta32-be"
1062 KBRANCH_qemuarm = "standard/default/arm-versatile-926ejs"
1063 </literallayout>
1064 Each of the above branches exist in the <filename>linux-yocto-3.2</filename> kernel Git
1065 repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.2/refs/heads'></ulink>.
1066 </para>
1067
1068 <para>
1069 This variable is also used from the kernel's append file to identify the kernel
1070 branch specific to a particular machine or target hardware.
1071 The kernel's append file is located in the BSP layer for a given machine.
1072 For example, the kernel append file for the Crown Bay BSP is in the
1073 <filename>meta-intel</filename> Git repository and is named
1074 <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.2.bbappend</filename>.
1075 Here are the related statements from the append file:
1076 <literallayout class='monospaced'>
1077 COMPATIBLE_MACHINE_crownbay = "crownbay"
1078 KMACHINE_crownbay = "crownbay"
1079 KBRANCH_crownbay = "standard/default/crownbay"
1080
1081 COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd"
1082 KMACHINE_crownbay-noemgd = "crownbay"
1083 KBRANCH_crownbay-noemgd = "standard/default/crownbay"
1084 </literallayout>
1085 The <filename>KBRANCH_*</filename> statements identify the kernel branch to
1086 use when building for the Crown Bay BSP.
1087 In this case there are two identical statements: one for each type of
1088 Crown Bay machine.
1089 </para>
1090 </glossdef>
1091 </glossentry>
1092
1038 <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm> 1093 <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm>
1039 <glossdef> 1094 <glossdef>
1040 <para>Includes additional metadata from the Yocto Project kernel Git repository. 1095 <para>Includes additional metadata from the Yocto Project kernel Git repository.