From 093b0079ce2df52e362d0a9b7b0f0184d9de4626 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 1 Feb 2013 15:10:01 -0600 Subject: [PATCH] dev-manual, ref-manual: Updates for BBPATH. Two things fixed: 1. A couple examples for setting up a layer.conf file were using the meta-yocto configuration file as an example. Turns out this is a bad example because the BBPATH variable is appended to the LAYERDIR when setting BBPATH rather than the other way around. That is because meta-yocto is a distro layer. BSP layers, however, are not distro layers and are the norm here. So I switched up the way BBPATH was set and actually called out meta-yocto-bsp config file as a template. 2. Added a link for the BBPATH variable in the FILESYSTEM_PERMS_TABLES variable description in the glossary. Just happened to notice this so I fixed it Reported-by: Robert P. J. Day (From yocto-docs rev: 1a594b6dde1a494a5f7322b510e1e67d23635298) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 75 +++++++++++++------ documentation/ref-manual/ref-variables.xml | 2 +- 2 files changed, 52 insertions(+), 25 deletions(-) diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index e7655ade9f..ff19fb716a 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -102,37 +102,64 @@ layer folder, you need to create a conf/layer.conf file. It is easiest to take an existing layer configuration file and copy that to your layer's conf directory and then modify the file as needed. - The meta-yocto/conf/layer.conf file demonstrates the + The meta-yocto-bsp/conf/layer.conf file demonstrates the required syntax: # We have a conf and classes directory, add to BBPATH - BBPATH := "${LAYERDIR}:${BBPATH}" + BBPATH := "${BBPATH}:${LAYERDIR}" - # We have recipes-* directories, add to BBFILES + # We have a packages directory, add to BBFILES BBFILES := "${BBFILES} ${LAYERDIR}/recipes-*/*/*.bb \ ${LAYERDIR}/recipes-*/*/*.bbappend" - BBFILE_COLLECTIONS += "yocto" - BBFILE_PATTERN_yocto := "^${LAYERDIR}/" - BBFILE_PRIORITY_yocto = "5" + BBFILE_COLLECTIONS += "yoctobsp" + BBFILE_PATTERN_yoctobsp := "^${LAYERDIR}/" + BBFILE_PRIORITY_yoctobsp = "5" - In the previous example, the recipes for the layers are added to - BBFILES. - The - BBFILE_COLLECTIONS - variable is then appended with the layer name. - The - BBFILE_PATTERN - variable is set to a regular expression and is used to match files - from BBFILES into a particular layer. - In this case, immediate expansion of - LAYERDIR - sets BBFILE_PATTERN to the layer's path. - The - BBFILE_PRIORITY - variable then assigns a priority to the layer. - Applying priorities is useful in situations where the same package might appear in multiple - layers and allows you to choose what layer should take precedence. + Here is an explanation of the example: + + The configuration and + classes directory is appended to + BBPATH. + + All non-distro layers, which include all BSP + layers, are expected to append the layer + directory to the + BBPATH. + On the other hand, distro layers, such as + meta-yocto, can choose + to enforce their own precedence over + BBPATH. + For an example of that syntax, see the + layer.conf file for + the meta-yocto layer. + + The recipes for the layers are + appended to + BBFILES. + + The + BBFILE_COLLECTIONS + variable is then appended with the layer name. + + The + BBFILE_PATTERN + variable is set to a regular expression and is + used to match files from + BBFILES into a particular + layer. + In this case, immediate expansion of + LAYERDIR + sets BBFILE_PATTERN to the + layer's path. + The + BBFILE_PRIORITY + variable then assigns a priority to the layer. + Applying priorities is useful in situations + where the same package might appear in multiple + layers and allows you to choose what layer + should take precedence. + Note the use of the LAYERDIR variable with the immediate expansion operator. @@ -1769,7 +1796,7 @@ the layer.conf file as follows: # We have a conf and classes directory, add to BBPATH - BBPATH := "${LAYERDIR}:${BBPATH}" + BBPATH := "${BBPATH}:${LAYERDIR}" # We have a packages directory, add to BBFILES BBFILES := "${BBFILES} ${LAYERDIR}/recipes-*/*/*.bb \ diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index ff9a227db1..dabf05989e 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -1138,7 +1138,7 @@ Core layer for images cannot be removed point to your custom fs-perms.txt. You can specify more than a single file permissions setting table. The paths you specify to these files must be defined within the - BBPATH variable. + BBPATH variable. For guidance on how to create your own file permissions settings table file,