summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@linux.intel.com>2011-08-23 15:33:13 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-08-24 19:49:37 -0700
commitcf654970763f4a8acaa52da61ef7dd4dd0b2b6fd (patch)
treee960c6cb6de4efbea42cf5137068d473b570bbf1 /documentation/poky-ref-manual/ref-variables.xml
parent75fc3840aafba5a676351bf0a940d8fe3ccb2b6b (diff)
downloadpoky-cf654970763f4a8acaa52da61ef7dd4dd0b2b6fd.tar.gz
documentation: update BBFILE_* variable documentation
* Add documentation of LAYERVERSION, LAYERDEPENDS and new layer priority behaviour * Improve some wording (From yocto-docs rev: be7c10f3b8b35ff231e5974a48936e66fd49fcbc) Signed-off-by: Paul Eggleton <paul.eggleton@linux.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.xml52
1 files changed, 43 insertions, 9 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 34ce56a080..b87ee42fe9 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -74,9 +74,10 @@
74 74
75 <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> 75 <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm>
76 <glossdef> 76 <glossdef>
77 <para>Identifies layer-specific <filename>.bbfiles</filename>, which contain recipes 77 <para>Lists the names of configured layers. These names are used to find the other BBFILE_*
78 used by BitBake to build software. 78 variables. Typically each layer will append its name to this variable in its
79 The variable is appended with a layer name.</para> 79 <filename>conf/layer.conf</filename> file.
80 </para>
80 </glossdef> 81 </glossdef>
81 </glossentry> 82 </glossentry>
82 83
@@ -84,14 +85,14 @@
84 <glossdef> 85 <glossdef>
85 <para>Variable that expands to match files from <filename>BBFILES</filename> in a particular layer. 86 <para>Variable that expands to match files from <filename>BBFILES</filename> in a particular layer.
86 This variable is used in the <filename>conf/layer.conf</filename> file and must 87 This variable is used in the <filename>conf/layer.conf</filename> file and must
87 contain the name of the 88 be suffixed with the name of the specific layer (e.g.
88 specific layer (e.g. <filename>BBFILE_PATTERN_emenlow</filename>).</para> 89 <filename>BBFILE_PATTERN_emenlow</filename>).</para>
89 </glossdef> 90 </glossdef>
90 </glossentry> 91 </glossentry>
91 92
92 <glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm> 93 <glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm>
93 <glossdef> 94 <glossdef>
94 <para>Assigns different priorities to recipe files in different layers.</para> 95 <para>Assigns the priority for recipe files in each layer.</para>
95 <para>This variable is useful in situations where the same package appears in 96 <para>This variable is useful in situations where the same package appears in
96 more than one layer. 97 more than one layer.
97 Setting this variable allows you to prioritize a 98 Setting this variable allows you to prioritize a
@@ -104,14 +105,22 @@
104 lower precedence.</para> 105 lower precedence.</para>
105 <para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher 106 <para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher
106 precedence. 107 precedence.
107 For example, the value 6 has a higher precedence than the value 5. 108 For example, the value 6 has a higher precedence than the
108 By default, the <filename>BBFILE_PRIORITY</filename> variable is set to "5".</para> 109 value 5.
110 If not specified, the BBFILE_PRIORITY variable is set based on layer
111 dependencies (see LAYERDEPENDS below). Tdefault priority if unspecified
112 for a layer with no dependencies is the lowest defined priority + 1
113 (or 1 if no priorities are defined).</para>
114 <tip>
115 You can use the command "bitbake-layers show_layers" to list
116 all configured layers along with their priorities.
117 </tip>
109 </glossdef> 118 </glossdef>
110 </glossentry> 119 </glossentry>
111 120
112 <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm> 121 <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
113 <glossdef> 122 <glossdef>
114 <para>List of recipes used by BitBake to build software</para> 123 <para>List of recipe files used by BitBake to build software</para>
115 </glossdef> 124 </glossdef>
116 </glossentry> 125 </glossentry>
117 126
@@ -540,6 +549,20 @@
540 549
541 <glossdiv id='var-glossary-l'><title>L</title> 550 <glossdiv id='var-glossary-l'><title>L</title>
542 551
552 <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm>
553 <glossdef>
554 <para>Lists the layers that this recipe depends upon, separated by spaces.
555 Optionally a specific layer version may be specified for a dependency
556 by adding it to the end of the layer name with a colon, e.g. "anotherlayer:3"
557 (to be compared against LAYERVERSION_anotherlayer in this example).
558 An error will be produced if any dependency is missing or
559 the version numbers do not match exactly (if specified).
560 This variable is used in the <filename>conf/layer.conf</filename> file
561 and must be suffixed with the name of the specific layer (e.g.
562 LAYERDEPENDS_mylayer).</para>
563 </glossdef>
564 </glossentry>
565
543 <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm> 566 <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm>
544 <glossdef> 567 <glossdef>
545 <para>When used inside the <filename>layer.conf</filename> configuration 568 <para>When used inside the <filename>layer.conf</filename> configuration
@@ -551,6 +574,17 @@
551 </glossdef> 574 </glossdef>
552 </glossentry> 575 </glossentry>
553 576
577 <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm>
578 <glossdef>
579 <para>Optionally specifies the version of a layer as a single number.
580 This may be used within LAYERDEPENDS for another layer in order to
581 depend on a specific version of the layer.
582 This variable is used in the <filename>conf/layer.conf</filename> file
583 and must be suffixed with the name of the specific layer (e.g.
584 LAYERVERSION_mylayer).</para>
585 </glossdef>
586 </glossentry>
587
554 <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm> 588 <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm>
555 <glossdef> 589 <glossdef>
556 <para>The list of package source licenses.</para> 590 <para>The list of package source licenses.</para>