From f00ba684e0a3d1bda15a6ca06cc4cd466f1eada0 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 6 Dec 2012 13:36:03 -0600 Subject: [PATCH] Documentation: dev-manual, bsp-guide, poky-ref-manual - bblayer.conf updates Fixes [YOCTO #3176] Several places throughout the YP manual set examples are given for the bblayer.conf file. For release 1.3, a bug existed that surfaced when a user removed either the meta or meta-yocto layer from this configuration file. The bug has been fixed and the ripple effect through the YP documentation set affected several manuals. Fixes include updating the code samples that show bblayer.conf so that they now include the BBLAYERS_NON_REMOVABLE variable, a new glossary entry for the variable, and an explanation of both BBLAYER and BBLAYER_NON_REMOVABLE in the section that talks about the bblayer.conf file. (From yocto-docs rev: 904b9ec1cd6d823af0e92f6891fc7e434cf2e358) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/bsp-guide/bsp.xml | 24 ++++++--- .../dev-manual/dev-manual-common-tasks.xml | 53 ++++++++++--------- .../poky-ref-manual/ref-structure.xml | 11 +++- .../poky-ref-manual/ref-variables.xml | 33 ++++++++++++ .../poky-ref-manual/technical-details.xml | 6 ++- 5 files changed, 94 insertions(+), 33 deletions(-) diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index a53ea98d8a..020e3508fa 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -52,12 +52,17 @@ definition and from it build an image. Here is an example: - BBLAYERS = " \ - /usr/local/src/yocto/meta \ - /usr/local/src/yocto/meta-yocto \ - /usr/local/src/yocto/meta-yocto-bsp \ - /usr/local/src/yocto/meta-<bsp_name> \ - " + BBLAYERS = ?" \ + /usr/local/src/yocto/meta \ + /usr/local/src/yocto/meta-yocto \ + /usr/local/src/yocto/meta-yocto-bsp \ + /usr/local/src/yocto/meta-mylayer \ + " + + BBLAYERS_NON_REMOVABLE ?= " \ + /usr/local/src/yocto/meta \ + /usr/local/src/yocto/meta-yocto \ + " @@ -1293,11 +1298,16 @@ bblayers.conf file. Here is an example: - BBLAYERS = " \ + BBLAYERS = ?" \ /usr/local/src/yocto/meta \ /usr/local/src/yocto/meta-yocto \ /usr/local/src/yocto/meta-yocto-bsp \ /usr/local/src/yocto/meta-myarm \ + " + + BBLAYERS_NON_REMOVABLE ?= " \ + /usr/local/src/yocto/meta \ + /usr/local/src/yocto/meta-yocto \ " Adding the layer to this file allows the build system to build the BSP and diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index e9f55ce1db..1e2ddefda0 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -217,10 +217,15 @@ BBFILES ?= "" BBLAYERS ?= " \ - /path/to/poky/meta \ - /path/to/poky/meta-yocto \ - /path/to/poky/meta-yocto-bsp \ - /path/to/poky/meta-mylayer \ + $HOME/poky/meta \ + $HOME/poky/meta-yocto \ + $HOME/poky/meta-yocto-bsp \ + $HOME/poky/meta-mylayer \ + " + + BBLAYERS_NON_REMOVABLE ?= " \ + $HOME/poky/meta \ + $HOME/poky/meta-yocto \ " @@ -232,14 +237,6 @@ During the processing of each conf/layer.conf file, BitBake adds the recipes, classes and configurations contained within the particular layer to the source directory. - - Removing the meta-yocto layer exposes a bug for the - current release of the Yocto Project. - If for some reason you do remove this layer from the - bblayers.conf, you must set the - LCONF_VERSION variable to "5". - See [YOCTO_#3176] - for more information. @@ -1816,14 +1813,18 @@ meta, meta-yocto, and meta-yocto-bsp in the poky Git repository. - Add the path to your meta-mylayer location. - Be sure to substitute your user information in the statement: + Add the path to your meta-mylayer location: - BBLAYERS = " \ - /home/<user>/poky/meta \ - /home/<user>/poky/meta-yocto \ - /home/<user>/poky/meta-yocto-bsp \ - /home/<user>/poky/meta-mylayer \ + BBLAYERS ?= " \ + $HOME/poky/meta \ + $HOME/poky/meta-yocto \ + $HOME/poky/meta-yocto-bsp \ + $HOME/poky/meta-mylayer \ + " + + BBLAYERS_NON_REMOVABLE ?= " \ + $HOME/poky/meta \ + $HOME/poky/meta-yocto \ " @@ -3048,11 +3049,15 @@ BBFILES ?= "" BBLAYERS ?= " \ - ##COREBASE##/meta \ - ##COREBASE##/meta-yocto \ - ##COREBASE##/meta-yocto-bsp \ - ##COREBASE##/meta-my-bsp-layer \ - ##COREBASE##/meta-my-software-layer \ + $HOME/poky/meta \ + $HOME/poky/meta-yocto \ + $HOME/poky/meta-yocto-bsp \ + $HOME/poky/meta-mylayer \ + " + + BBLAYERS_NON_REMOVABLE ?= " \ + $HOME/poky/meta \ + $HOME/poky/meta-yocto \ " Creating and providing an archive of the metadata layers diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index c2644df374..166907ceef 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml @@ -247,11 +247,20 @@ <filename>build/conf/bblayers.conf</filename> - This file defines layers, which is a directory tree, traversed (or walked) by BitBake. + This file defines layers, which are directory trees, traversed (or walked) by BitBake. If bblayers.conf is not present, it is created from bblayers.conf.sample when you source the environment setup script. + + + The bblayers.conf file uses the + BBLAYERS variable to + list the layers BitBake tries to find. + The file uses the + BBLAYERS_NON_REMOVABLE + variable to list layers that must not be removed. +
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 9ced42499e..0de6bfcf5c 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml @@ -421,6 +421,11 @@ /home/scottrif/poky/meta-yocto \ /home/scottrif/poky/meta-yocto-bsp \ /home/scottrif/poky/meta-mykernel \ + " + + BBLAYERS_NON_REMOVABLE ?= " \ + /home/scottrif/poky/meta \ + /home/scottrif/poky/meta-yocto \ " This example enables four layers, one of which is a custom, user-defined layer @@ -429,6 +434,34 @@ + BBLAYERS_NON_REMOVABLE + +Core layer for images cannot be removed + Lists core layers that cannot be removed from the + bblayers.conf file. + In order for BitBake to build your image, your + bblayers.conf file must include the + meta and meta-yocto + core layers. + Here is an example that shows these two layers listed in + the BBLAYERS_NON_REMOVABLE statement: + + BBLAYERS = " \ + /home/scottrif/poky/meta \ + /home/scottrif/poky/meta-yocto \ + /home/scottrif/poky/meta-yocto-bsp \ + /home/scottrif/poky/meta-mykernel \ + " + + BBLAYERS_NON_REMOVABLE ?= " \ + /home/scottrif/poky/meta \ + /home/scottrif/poky/meta-yocto \ + " + + + + + BP The base recipe name and version but without any special diff --git a/documentation/poky-ref-manual/technical-details.xml b/documentation/poky-ref-manual/technical-details.xml index 654d9252a9..042a96ed87 100644 --- a/documentation/poky-ref-manual/technical-details.xml +++ b/documentation/poky-ref-manual/technical-details.xml @@ -662,7 +662,11 @@ /home/nitin/prj/poky.git/meta-yocto \ /home/nitin/prj/poky.git/meta-yocto-bsp \ /home/nitin/prj/meta-x32.git \ - " + " + BBLAYERS_NON_REMOVABLE ?= " \ + /home/nitin/prj/poky.git/meta \ + /home/nitin/prj/poky.git/meta-yocto \ + " Enable the x32 psABI tuning file for x86_64 machines by editing the conf/local.conf like this: