diff options
Diffstat (limited to 'documentation/poky-ref-manual/ref-variables.xml')
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 1292 |
1 files changed, 646 insertions, 646 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 275a7465b8..03875132cc 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
@@ -16,48 +16,48 @@ | |||
16 | 16 | ||
17 | 17 | ||
18 | <para> | 18 | <para> |
19 | <link linkend='var-ALLOW_EMPTY'>A</link> | 19 | <link linkend='var-ALLOW_EMPTY'>A</link> |
20 | <link linkend='var-B'>B</link> | 20 | <link linkend='var-B'>B</link> |
21 | <link linkend='var-CFLAGS'>C</link> | 21 | <link linkend='var-CFLAGS'>C</link> |
22 | <link linkend='var-D'>D</link> | 22 | <link linkend='var-D'>D</link> |
23 | <link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link> | 23 | <link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link> |
24 | <link linkend='var-FILES'>F</link> | 24 | <link linkend='var-FILES'>F</link> |
25 | <!-- <link linkend='var-glossary-g'>G</link> --> | 25 | <!-- <link linkend='var-glossary-g'>G</link> --> |
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-KBRANCH'>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> --> |
33 | <link linkend='var-OE_TERMINAL'>O</link> | 33 | <link linkend='var-OE_TERMINAL'>O</link> |
34 | <link linkend='var-P'>P</link> | 34 | <link linkend='var-P'>P</link> |
35 | <!-- <link linkend='var-glossary-q'>Q</link> --> | 35 | <!-- <link linkend='var-glossary-q'>Q</link> --> |
36 | <link linkend='var-RCONFLICTS'>R</link> | 36 | <link linkend='var-RCONFLICTS'>R</link> |
37 | <link linkend='var-S'>S</link> | 37 | <link linkend='var-S'>S</link> |
38 | <link linkend='var-T'>T</link> | 38 | <link linkend='var-T'>T</link> |
39 | <!-- <link linkend='var-glossary-u'>U</link> --> | 39 | <!-- <link linkend='var-glossary-u'>U</link> --> |
40 | <!-- <link linkend='var-glossary-v'>V</link> --> | 40 | <!-- <link linkend='var-glossary-v'>V</link> --> |
41 | <link linkend='var-WORKDIR'>W</link> | 41 | <link linkend='var-WORKDIR'>W</link> |
42 | <!-- <link linkend='var-glossary-x'>X</link> --> | 42 | <!-- <link linkend='var-glossary-x'>X</link> --> |
43 | <!-- <link linkend='var-glossary-y'>Y</link> --> | 43 | <!-- <link linkend='var-glossary-y'>Y</link> --> |
44 | <!-- <link linkend='var-glossary-z'>Z</link>--> | 44 | <!-- <link linkend='var-glossary-z'>Z</link>--> |
45 | </para> | 45 | </para> |
46 | 46 | ||
47 | <glossdiv id='var-glossary-a'><title>A</title> | 47 | <glossdiv id='var-glossary-a'><title>A</title> |
48 | 48 | ||
49 | <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm> | 49 | <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm> |
50 | <glossdef> | 50 | <glossdef> |
51 | <para> | 51 | <para> |
52 | Specifies if an output package should still be produced if it is empty. | 52 | Specifies if an output package should still be produced if it is empty. |
53 | By default, BitBake does not produce empty packages. | 53 | By default, BitBake does not produce empty packages. |
54 | This default behavior can cause issues when there is an | 54 | This default behavior can cause issues when there is an |
55 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> or | 55 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> or |
56 | some other runtime hard-requirement on the existence of the package. | 56 | some other runtime hard-requirement on the existence of the package. |
57 | </para> | 57 | </para> |
58 | 58 | ||
59 | <para> | 59 | <para> |
60 | Like all package-controlling variables, you must always use them in | 60 | Like all package-controlling variables, you must always use them in |
61 | conjunction with a package name override. | 61 | conjunction with a package name override. |
62 | Here is an example: | 62 | Here is an example: |
63 | <literallayout class='monospaced'> | 63 | <literallayout class='monospaced'> |
@@ -69,7 +69,7 @@ | |||
69 | 69 | ||
70 | <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> | 70 | <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> |
71 | <glossdef> | 71 | <glossdef> |
72 | <para>The email address used to contact the original author or authors in | 72 | <para>The email address used to contact the original author or authors in |
73 | order to send patches, forward bugs, etc.</para> | 73 | order to send patches, forward bugs, etc.</para> |
74 | </glossdef> | 74 | </glossdef> |
75 | </glossentry> | 75 | </glossentry> |
@@ -86,7 +86,7 @@ | |||
86 | </glossdef> | 86 | </glossdef> |
87 | </glossentry> | 87 | </glossentry> |
88 | 88 | ||
89 | </glossdiv> | 89 | </glossdiv> |
90 | 90 | ||
91 | <glossdiv id='var-glossary-b'><title>B</title> | 91 | <glossdiv id='var-glossary-b'><title>B</title> |
92 | 92 | ||
@@ -101,7 +101,7 @@ | |||
101 | <literallayout class='monospaced'> | 101 | <literallayout class='monospaced'> |
102 | B = ${WORKDIR}/${BPN}-{PV}/ | 102 | B = ${WORKDIR}/${BPN}-{PV}/ |
103 | </literallayout> | 103 | </literallayout> |
104 | You can separate the (<filename>S</filename>) directory and the directory pointed to | 104 | You can separate the (<filename>S</filename>) directory and the directory pointed to |
105 | by the <filename>B</filename> variable. | 105 | by the <filename>B</filename> variable. |
106 | Most autotools-based recipes support separating these directories. | 106 | Most autotools-based recipes support separating these directories. |
107 | The build system defaults to using separate directories for <filename>gcc</filename> | 107 | The build system defaults to using separate directories for <filename>gcc</filename> |
@@ -114,7 +114,7 @@ | |||
114 | <glossdef> | 114 | <glossdef> |
115 | <para> | 115 | <para> |
116 | A list of packages not to install despite being recommended by a recipe. | 116 | A list of packages not to install despite being recommended by a recipe. |
117 | Support for this variable exists only when using the | 117 | Support for this variable exists only when using the |
118 | <filename>ipk</filename> packaging backend. | 118 | <filename>ipk</filename> packaging backend. |
119 | </para> | 119 | </para> |
120 | </glossdef> | 120 | </glossdef> |
@@ -124,50 +124,50 @@ | |||
124 | <glossdef> | 124 | <glossdef> |
125 | <para> | 125 | <para> |
126 | Monitors disk space and available inodes during the build | 126 | Monitors disk space and available inodes during the build |
127 | and allows you to control the build based on these | 127 | and allows you to control the build based on these |
128 | parameters. | 128 | parameters. |
129 | </para> | 129 | </para> |
130 | 130 | ||
131 | <para> | 131 | <para> |
132 | Disk space monitoring is disabled by default. | 132 | Disk space monitoring is disabled by default. |
133 | To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename> | 133 | To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename> |
134 | variable to your <filename>conf/local.conf</filename> file found in the | 134 | variable to your <filename>conf/local.conf</filename> file found in the |
135 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 135 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
136 | Use the following form: | 136 | Use the following form: |
137 | <literallayout class='monospaced'> | 137 | <literallayout class='monospaced'> |
138 | BB_DISKMON_DIRS = "<action>,<dir>,<threshold> [...]" | 138 | BB_DISKMON_DIRS = "<action>,<dir>,<threshold> [...]" |
139 | 139 | ||
140 | where: | 140 | where: |
141 | 141 | ||
142 | <action> is: | 142 | <action> is: |
143 | ABORT: Immediately abort the build when | 143 | ABORT: Immediately abort the build when |
144 | a threshold is broken. | 144 | a threshold is broken. |
145 | STOPTASKS: Stop the build after the currently | 145 | STOPTASKS: Stop the build after the currently |
146 | executing tasks have finished when | 146 | executing tasks have finished when |
147 | a threshold is broken. | 147 | a threshold is broken. |
148 | WARN: Issue a warning but continue the | 148 | WARN: Issue a warning but continue the |
149 | build when a threshold is broken. | 149 | build when a threshold is broken. |
150 | Subsequent warnings are issued as | 150 | Subsequent warnings are issued as |
151 | defined by the | 151 | defined by the |
152 | <link linkend='var-BB_DISKMON_WARNINTERVAL'>BB_DISKMON_WARNINTERVAL</link> variable, | 152 | <link linkend='var-BB_DISKMON_WARNINTERVAL'>BB_DISKMON_WARNINTERVAL</link> variable, |
153 | which must be defined in the | 153 | which must be defined in the |
154 | conf/local.conf file. | 154 | conf/local.conf file. |
155 | 155 | ||
156 | <dir> is: | 156 | <dir> is: |
157 | Any directory you choose. You can specify one or | 157 | Any directory you choose. You can specify one or |
158 | more directories to monitor by separating the | 158 | more directories to monitor by separating the |
159 | groupings with a space. If two directories are | 159 | groupings with a space. If two directories are |
160 | on the same device, only the first directory | 160 | on the same device, only the first directory |
161 | is monitored. | 161 | is monitored. |
162 | 162 | ||
163 | <threshold> is: | 163 | <threshold> is: |
164 | Either the minimum available disk space, | 164 | Either the minimum available disk space, |
165 | the minimum number of free inodes, or | 165 | the minimum number of free inodes, or |
166 | both. You must specify at least one. To | 166 | both. You must specify at least one. To |
167 | omit one or the other, simply omit the value. | 167 | omit one or the other, simply omit the value. |
168 | Specify the threshold using G, M, K for Gbytes, | 168 | Specify the threshold using G, M, K for Gbytes, |
169 | Mbytes, and Kbytes, respectively. If you do | 169 | Mbytes, and Kbytes, respectively. If you do |
170 | not specify G, M, or K, Kbytes is assumed by | 170 | not specify G, M, or K, Kbytes is assumed by |
171 | default. Do not use GB, MB, or KB. | 171 | default. Do not use GB, MB, or KB. |
172 | </literallayout> | 172 | </literallayout> |
173 | </para> | 173 | </para> |
@@ -179,36 +179,36 @@ | |||
179 | BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" | 179 | BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" |
180 | BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" | 180 | BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" |
181 | </literallayout> | 181 | </literallayout> |
182 | The first example works only if you also provide | 182 | The first example works only if you also provide |
183 | the <link linkend='var-BB_DISKMON_WARNINTERVAL'><filename>BB_DISKMON_WARNINTERVAL</filename></link> variable | 183 | the <link linkend='var-BB_DISKMON_WARNINTERVAL'><filename>BB_DISKMON_WARNINTERVAL</filename></link> variable |
184 | in the <filename>conf/local.conf</filename>. | 184 | in the <filename>conf/local.conf</filename>. |
185 | This example causes the build system to immediately | 185 | This example causes the build system to immediately |
186 | abort when either the disk space in <filename>${TMPDIR}</filename> drops | 186 | abort when either the disk space in <filename>${TMPDIR}</filename> drops |
187 | below 1 Gbyte or the available free inodes drops below | 187 | below 1 Gbyte or the available free inodes drops below |
188 | 100 Kbytes. | 188 | 100 Kbytes. |
189 | Because two directories are provided with the variable, the | 189 | Because two directories are provided with the variable, the |
190 | build system also issue a | 190 | build system also issue a |
191 | warning when the disk space in the | 191 | warning when the disk space in the |
192 | <filename>${SSTATE_DIR}</filename> directory drops | 192 | <filename>${SSTATE_DIR}</filename> directory drops |
193 | below 1 Gbyte or the number of free inodes drops | 193 | below 1 Gbyte or the number of free inodes drops |
194 | below 100 Kbytes. | 194 | below 100 Kbytes. |
195 | Subsequent warnings are issued during intervals as | 195 | Subsequent warnings are issued during intervals as |
196 | defined by the <filename>BB_DISKMON_WARNINTERVAL</filename> | 196 | defined by the <filename>BB_DISKMON_WARNINTERVAL</filename> |
197 | variable. | 197 | variable. |
198 | </para> | 198 | </para> |
199 | 199 | ||
200 | <para> | 200 | <para> |
201 | The second example stops the build after all currently | 201 | The second example stops the build after all currently |
202 | executing tasks complete when the minimum disk space | 202 | executing tasks complete when the minimum disk space |
203 | in the <filename>${TMPDIR}</filename> directory drops | 203 | in the <filename>${TMPDIR}</filename> directory drops |
204 | below 1 Gbyte. | 204 | below 1 Gbyte. |
205 | No disk monitoring occurs for the free inodes in this case. | 205 | No disk monitoring occurs for the free inodes in this case. |
206 | </para> | 206 | </para> |
207 | 207 | ||
208 | <para> | 208 | <para> |
209 | The final example immediately aborts the build when the | 209 | The final example immediately aborts the build when the |
210 | number of free inodes in the <filename>${TMPDIR}</filename> directory | 210 | number of free inodes in the <filename>${TMPDIR}</filename> directory |
211 | drops below 100 Kbytes. | 211 | drops below 100 Kbytes. |
212 | No disk space monitoring for the directory itself occurs | 212 | No disk space monitoring for the directory itself occurs |
213 | in this case. | 213 | in this case. |
214 | </para> | 214 | </para> |
@@ -219,26 +219,26 @@ | |||
219 | <glossdef> | 219 | <glossdef> |
220 | <para> | 220 | <para> |
221 | Defines the disk space and free inode warning intervals. | 221 | Defines the disk space and free inode warning intervals. |
222 | To set these intervals, define the variable in your | 222 | To set these intervals, define the variable in your |
223 | <filename>conf/local.conf</filename> file in the | 223 | <filename>conf/local.conf</filename> file in the |
224 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 224 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
225 | </para> | 225 | </para> |
226 | 226 | ||
227 | <para> | 227 | <para> |
228 | If you are going to use the | 228 | If you are going to use the |
229 | <filename>BB_DISKMON_WARNINTERVAL</filename> variable, you must | 229 | <filename>BB_DISKMON_WARNINTERVAL</filename> variable, you must |
230 | also use the | 230 | also use the |
231 | <link linkend='var-BB_DISKMON_DIRS'><filename>BB_DISKMON_DIRS</filename></link> variable | 231 | <link linkend='var-BB_DISKMON_DIRS'><filename>BB_DISKMON_DIRS</filename></link> variable |
232 | and define its action as "WARN". | 232 | and define its action as "WARN". |
233 | During the build, subsequent warnings are issued each time | 233 | During the build, subsequent warnings are issued each time |
234 | disk space or number of free inodes further reduces by | 234 | disk space or number of free inodes further reduces by |
235 | the respective interval. | 235 | the respective interval. |
236 | </para> | 236 | </para> |
237 | 237 | ||
238 | <para> | 238 | <para> |
239 | If you do not provide a <filename>BB_DISKMON_WARNINTERVAL</filename> | 239 | If you do not provide a <filename>BB_DISKMON_WARNINTERVAL</filename> |
240 | variable and you do use <filename>BB_DISKMON_DIRS</filename> with | 240 | variable and you do use <filename>BB_DISKMON_DIRS</filename> with |
241 | the "WARN" action, the disk monitoring interval defaults to | 241 | the "WARN" action, the disk monitoring interval defaults to |
242 | the following: | 242 | the following: |
243 | <literallayout class='monospaced'> | 243 | <literallayout class='monospaced'> |
244 | BB_DISKMON_WARNINTERVAL = "50M,5K" | 244 | BB_DISKMON_WARNINTERVAL = "50M,5K" |
@@ -246,22 +246,22 @@ | |||
246 | </para> | 246 | </para> |
247 | 247 | ||
248 | <para> | 248 | <para> |
249 | When specifying the variable in your configuration file, | 249 | When specifying the variable in your configuration file, |
250 | use the following form: | 250 | use the following form: |
251 | <literallayout class='monospaced'> | 251 | <literallayout class='monospaced'> |
252 | BB_DISKMON_WARNINTERVAL = "<disk_space_interval>,<disk_inode_interval>" | 252 | BB_DISKMON_WARNINTERVAL = "<disk_space_interval>,<disk_inode_interval>" |
253 | 253 | ||
254 | where: | 254 | where: |
255 | 255 | ||
256 | <disk_space_interval> is: | 256 | <disk_space_interval> is: |
257 | An interval of memory expressed in either | 257 | An interval of memory expressed in either |
258 | G, M, or K for Gbytes, Mbytes, or Kbytes, | 258 | G, M, or K for Gbytes, Mbytes, or Kbytes, |
259 | respectively. You cannot use GB, MB, or KB. | 259 | respectively. You cannot use GB, MB, or KB. |
260 | 260 | ||
261 | <disk_inode_interval> is: | 261 | <disk_inode_interval> is: |
262 | An interval of free inodes expressed in either | 262 | An interval of free inodes expressed in either |
263 | G, M, or K for Gbytes, Mbytes, or Kbytes, | 263 | G, M, or K for Gbytes, Mbytes, or Kbytes, |
264 | respectively. You cannot use GB, MB, or KB. | 264 | respectively. You cannot use GB, MB, or KB. |
265 | </literallayout> | 265 | </literallayout> |
266 | </para> | 266 | </para> |
267 | 267 | ||
@@ -271,12 +271,12 @@ | |||
271 | BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K" | 271 | BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K" |
272 | BB_DISKMON_WARNINTERVAL = "50M,5K" | 272 | BB_DISKMON_WARNINTERVAL = "50M,5K" |
273 | </literallayout> | 273 | </literallayout> |
274 | These variables cause the OpenEmbedded build system to | 274 | These variables cause the OpenEmbedded build system to |
275 | issue subsequent warnings each time the available | 275 | issue subsequent warnings each time the available |
276 | disk space further reduces by 50 Mbytes or the number | 276 | disk space further reduces by 50 Mbytes or the number |
277 | of free inodes further reduces by 5 Kbytes in the | 277 | of free inodes further reduces by 5 Kbytes in the |
278 | <filename>${SSTATE_DIR}</filename> directory. | 278 | <filename>${SSTATE_DIR}</filename> directory. |
279 | Subsequent warnings based on the interval occur each time | 279 | Subsequent warnings based on the interval occur each time |
280 | a respective interval is reached beyond the intial warning | 280 | a respective interval is reached beyond the intial warning |
281 | (i.e. 1 Gbytes and 100 Kbytes). | 281 | (i.e. 1 Gbytes and 100 Kbytes). |
282 | </para> | 282 | </para> |
@@ -310,24 +310,24 @@ | |||
310 | <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm> | 310 | <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm> |
311 | <glossdef> | 311 | <glossdef> |
312 | <para>Prevents BitBake from processing recipes and recipe append files. | 312 | <para>Prevents BitBake from processing recipes and recipe append files. |
313 | You can use the <filename>BBMASK</filename> variable to "hide" | 313 | You can use the <filename>BBMASK</filename> variable to "hide" |
314 | these <filename>.bb</filename> and <filename>.bbappend</filename> files. | 314 | these <filename>.bb</filename> and <filename>.bbappend</filename> files. |
315 | BitBake ignores any recipe or recipe append files that match the expression. | 315 | BitBake ignores any recipe or recipe append files that match the expression. |
316 | It is as if BitBake does not see them at all. | 316 | It is as if BitBake does not see them at all. |
317 | Consequently, matching files are not parsed or otherwise used by | 317 | Consequently, matching files are not parsed or otherwise used by |
318 | BitBake.</para> | 318 | BitBake.</para> |
319 | <para>The value you provide is passed to python's regular expression compiler. | 319 | <para>The value you provide is passed to python's regular expression compiler. |
320 | For complete syntax information, see python's documentation at | 320 | For complete syntax information, see python's documentation at |
321 | <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>. | 321 | <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>. |
322 | The expression is compared against the full paths to the files. | 322 | The expression is compared against the full paths to the files. |
323 | For example, the following uses a complete regular expression to tell | 323 | For example, the following uses a complete regular expression to tell |
324 | BitBake to ignore all recipe and recipe append files in the | 324 | BitBake to ignore all recipe and recipe append files in the |
325 | <filename>.*/meta-ti/recipes-misc/</filename> directory: | 325 | <filename>.*/meta-ti/recipes-misc/</filename> directory: |
326 | <literallayout class='monospaced'> | 326 | <literallayout class='monospaced'> |
327 | BBMASK = ".*/meta-ti/recipes-misc/" | 327 | BBMASK = ".*/meta-ti/recipes-misc/" |
328 | </literallayout></para> | 328 | </literallayout></para> |
329 | <para>Use the <filename>BBMASK</filename> variable from within the | 329 | <para>Use the <filename>BBMASK</filename> variable from within the |
330 | <filename>conf/local.conf</filename> file found | 330 | <filename>conf/local.conf</filename> file found |
331 | in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.</para> | 331 | in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.</para> |
332 | </glossdef> | 332 | </glossdef> |
333 | </glossentry> | 333 | </glossentry> |
@@ -342,9 +342,9 @@ | |||
342 | 342 | ||
343 | <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> | 343 | <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> |
344 | <glossdef> | 344 | <glossdef> |
345 | <para>Lists the names of configured layers. | 345 | <para>Lists the names of configured layers. |
346 | These names are used to find the other <filename>BBFILE_*</filename> | 346 | These names are used to find the other <filename>BBFILE_*</filename> |
347 | variables. | 347 | variables. |
348 | Typically, each layer will append its name to this variable in its | 348 | Typically, each layer will append its name to this variable in its |
349 | <filename>conf/layer.conf</filename> file. | 349 | <filename>conf/layer.conf</filename> file. |
350 | </para> | 350 | </para> |
@@ -353,9 +353,9 @@ | |||
353 | 353 | ||
354 | <glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm> | 354 | <glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm> |
355 | <glossdef> | 355 | <glossdef> |
356 | <para>Variable that expands to match files from <filename>BBFILES</filename> in a particular layer. | 356 | <para>Variable that expands to match files from <filename>BBFILES</filename> in a particular layer. |
357 | This variable is used in the <filename>conf/layer.conf</filename> file and must | 357 | This variable is used in the <filename>conf/layer.conf</filename> file and must |
358 | be suffixed with the name of the specific layer (e.g. | 358 | be suffixed with the name of the specific layer (e.g. |
359 | <filename>BBFILE_PATTERN_emenlow</filename>).</para> | 359 | <filename>BBFILE_PATTERN_emenlow</filename>).</para> |
360 | </glossdef> | 360 | </glossdef> |
361 | </glossentry> | 361 | </glossentry> |
@@ -364,21 +364,21 @@ | |||
364 | <glossdef> | 364 | <glossdef> |
365 | <para>Assigns the priority for recipe files in each layer.</para> | 365 | <para>Assigns the priority for recipe files in each layer.</para> |
366 | <para>This variable is useful in situations where the same recipe appears in | 366 | <para>This variable is useful in situations where the same recipe appears in |
367 | more than one layer. | 367 | more than one layer. |
368 | Setting this variable allows you to prioritize a | 368 | Setting this variable allows you to prioritize a |
369 | layer against other layers that contain the same recipe - effectively | 369 | layer against other layers that contain the same recipe - effectively |
370 | letting you control the precedence for the multiple layers. | 370 | letting you control the precedence for the multiple layers. |
371 | The precedence established through this variable stands regardless of a | 371 | The precedence established through this variable stands regardless of a |
372 | recipe's version (<filename>PV</filename> variable). | 372 | recipe's version (<filename>PV</filename> variable). |
373 | For example, a layer that has a recipe with a higher <filename>PV</filename> value but for | 373 | For example, a layer that has a recipe with a higher <filename>PV</filename> value but for |
374 | which the <filename>BBFILE_PRIORITY</filename> is set to have a lower precedence still has a | 374 | which the <filename>BBFILE_PRIORITY</filename> is set to have a lower precedence still has a |
375 | lower precedence.</para> | 375 | lower precedence.</para> |
376 | <para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher | 376 | <para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher |
377 | precedence. | 377 | precedence. |
378 | For example, the value 6 has a higher precedence than the value 5. | 378 | For example, the value 6 has a higher precedence than the value 5. |
379 | If not specified, the <filename>BBFILE_PRIORITY</filename> variable is set based on layer | 379 | If not specified, the <filename>BBFILE_PRIORITY</filename> variable is set based on layer |
380 | dependencies (see the | 380 | dependencies (see the |
381 | <filename><link linkend='var-LAYERDEPENDS'>LAYERDEPENDS</link></filename> variable for | 381 | <filename><link linkend='var-LAYERDEPENDS'>LAYERDEPENDS</link></filename> variable for |
382 | more information. | 382 | more information. |
383 | The default priority, if unspecified | 383 | The default priority, if unspecified |
384 | for a layer with no dependencies, is the lowest defined priority + 1 | 384 | for a layer with no dependencies, is the lowest defined priority + 1 |
@@ -398,7 +398,7 @@ | |||
398 | 398 | ||
399 | <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> | 399 | <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> |
400 | <glossdef> | 400 | <glossdef> |
401 | <para>Used by BitBake to locate <filename>.bbclass</filename> and configuration files. | 401 | <para>Used by BitBake to locate <filename>.bbclass</filename> and configuration files. |
402 | This variable is analogous to the <filename>PATH</filename> variable.</para> | 402 | This variable is analogous to the <filename>PATH</filename> variable.</para> |
403 | </glossdef> | 403 | </glossdef> |
404 | </glossentry> | 404 | </glossentry> |
@@ -411,9 +411,9 @@ | |||
411 | 411 | ||
412 | <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm> | 412 | <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm> |
413 | <glossdef> | 413 | <glossdef> |
414 | <para>Lists the layers to enable during the build. | 414 | <para>Lists the layers to enable during the build. |
415 | This variable is defined in the <filename>bblayers.conf</filename> configuration | 415 | This variable is defined in the <filename>bblayers.conf</filename> configuration |
416 | file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 416 | file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
417 | Here is an example: | 417 | Here is an example: |
418 | <literallayout class='monospaced'> | 418 | <literallayout class='monospaced'> |
419 | BBLAYERS = " \ | 419 | BBLAYERS = " \ |
@@ -428,7 +428,7 @@ | |||
428 | /home/scottrif/poky/meta-yocto \ | 428 | /home/scottrif/poky/meta-yocto \ |
429 | " | 429 | " |
430 | </literallayout> | 430 | </literallayout> |
431 | This example enables four layers, one of which is a custom, user-defined layer | 431 | This example enables four layers, one of which is a custom, user-defined layer |
432 | named <filename>meta-mykernel</filename>. | 432 | named <filename>meta-mykernel</filename>. |
433 | </para> | 433 | </para> |
434 | </glossdef> | 434 | </glossdef> |
@@ -464,7 +464,7 @@ Core layer for images cannot be removed | |||
464 | 464 | ||
465 | <glossentry id='var-BP'><glossterm>BP</glossterm> | 465 | <glossentry id='var-BP'><glossterm>BP</glossterm> |
466 | <glossdef> | 466 | <glossdef> |
467 | <para>The base recipe name and version but without any special | 467 | <para>The base recipe name and version but without any special |
468 | recipe name suffix (i.e. <filename>-native</filename>, <filename>lib64-</filename>, | 468 | recipe name suffix (i.e. <filename>-native</filename>, <filename>lib64-</filename>, |
469 | and so forth). | 469 | and so forth). |
470 | <filename>BP</filename> is comprised of the following: | 470 | <filename>BP</filename> is comprised of the following: |
@@ -495,8 +495,8 @@ Core layer for images cannot be removed | |||
495 | <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm> | 495 | <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm> |
496 | <glossdef> | 496 | <glossdef> |
497 | <para> | 497 | <para> |
498 | Flags passed to C compiler for the target system. | 498 | Flags passed to C compiler for the target system. |
499 | This variable evaluates to the same as | 499 | This variable evaluates to the same as |
500 | <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>. | 500 | <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>. |
501 | </para> | 501 | </para> |
502 | </glossdef> | 502 | </glossdef> |
@@ -504,7 +504,7 @@ Core layer for images cannot be removed | |||
504 | 504 | ||
505 | <glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm> | 505 | <glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm> |
506 | <glossdef> | 506 | <glossdef> |
507 | <para>A set of features common between | 507 | <para>A set of features common between |
508 | <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> | 508 | <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> |
509 | and <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. | 509 | and <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. |
510 | See the glossary descriptions for these variables for more information.</para> | 510 | See the glossary descriptions for these variables for more information.</para> |
@@ -513,11 +513,11 @@ Core layer for images cannot be removed | |||
513 | 513 | ||
514 | <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> | 514 | <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> |
515 | <glossdef> | 515 | <glossdef> |
516 | <para>A regular expression which evaluates to match the machines the recipe | 516 | <para>A regular expression which evaluates to match the machines the recipe |
517 | works with. | 517 | works with. |
518 | It stops recipes being run on machines for which they are not compatible. | 518 | It stops recipes being run on machines for which they are not compatible. |
519 | This is particularly useful with kernels. | 519 | This is particularly useful with kernels. |
520 | It also helps to increase parsing speed as further parsing of the recipe is skipped | 520 | It also helps to increase parsing speed as further parsing of the recipe is skipped |
521 | if it is found the current machine is not compatible.</para> | 521 | if it is found the current machine is not compatible.</para> |
522 | </glossdef> | 522 | </glossdef> |
523 | </glossentry> | 523 | </glossentry> |
@@ -527,46 +527,46 @@ Core layer for images cannot be removed | |||
527 | <para> | 527 | <para> |
528 | Identifies editable or configurable files that are part of a package. | 528 | Identifies editable or configurable files that are part of a package. |
529 | If the Package Management System (PMS) is being used to update | 529 | If the Package Management System (PMS) is being used to update |
530 | packages on the target system, it is possible that | 530 | packages on the target system, it is possible that |
531 | configuration files you have changed after the original installation | 531 | configuration files you have changed after the original installation |
532 | and that you now want to remain unchanged are overwritten. | 532 | and that you now want to remain unchanged are overwritten. |
533 | In other words, editable files might exist in the package that you do not | 533 | In other words, editable files might exist in the package that you do not |
534 | want reset as part of the package update process. | 534 | want reset as part of the package update process. |
535 | You can use the <filename>CONFFILES</filename> variable to list the files in the | 535 | You can use the <filename>CONFFILES</filename> variable to list the files in the |
536 | package that you wish to prevent the PMS from overwriting during this update process. | 536 | package that you wish to prevent the PMS from overwriting during this update process. |
537 | </para> | 537 | </para> |
538 | 538 | ||
539 | <para> | 539 | <para> |
540 | To use the <filename>CONFFILES</filename> variable, provide a package name | 540 | To use the <filename>CONFFILES</filename> variable, provide a package name |
541 | override that identifies the resulting package. | 541 | override that identifies the resulting package. |
542 | Then, provide a space-separated list of files. | 542 | Then, provide a space-separated list of files. |
543 | Here is an example: | 543 | Here is an example: |
544 | <literallayout class='monospaced'> | 544 | <literallayout class='monospaced'> |
545 | CONFFILES_${PN} += "${sysconfdir}/file1 \ | 545 | CONFFILES_${PN} += "${sysconfdir}/file1 \ |
546 | ${sysconfdir}/file2 ${sysconfdir}/file3" | 546 | ${sysconfdir}/file2 ${sysconfdir}/file3" |
547 | </literallayout> | 547 | </literallayout> |
548 | </para> | 548 | </para> |
549 | 549 | ||
550 | <para> | 550 | <para> |
551 | A relationship exists between the <filename>CONFFILES</filename> and | 551 | A relationship exists between the <filename>CONFFILES</filename> and |
552 | <filename><link linkend='var-FILES'>FILES</link></filename> variables. | 552 | <filename><link linkend='var-FILES'>FILES</link></filename> variables. |
553 | The files listed within <filename>CONFFILES</filename> must be a subset of | 553 | The files listed within <filename>CONFFILES</filename> must be a subset of |
554 | the files listed within <filename>FILES</filename>. | 554 | the files listed within <filename>FILES</filename>. |
555 | Because the configuration files you provide with <filename>CONFFILES</filename> | 555 | Because the configuration files you provide with <filename>CONFFILES</filename> |
556 | are simply being identified so that the PMS will not overwrite them, | 556 | are simply being identified so that the PMS will not overwrite them, |
557 | it makes sense that | 557 | it makes sense that |
558 | the files must already be included as part of the package through the | 558 | the files must already be included as part of the package through the |
559 | <filename>FILES</filename> variable. | 559 | <filename>FILES</filename> variable. |
560 | </para> | 560 | </para> |
561 | 561 | ||
562 | <note> | 562 | <note> |
563 | When specifying paths as part of the <filename>CONFFILES</filename> variable, | 563 | When specifying paths as part of the <filename>CONFFILES</filename> variable, |
564 | it is good practice to use appropriate path variables. | 564 | it is good practice to use appropriate path variables. |
565 | For example, <filename>${sysconfdir}</filename> rather than | 565 | For example, <filename>${sysconfdir}</filename> rather than |
566 | <filename>/etc</filename> or <filename>${bindir}</filename> rather | 566 | <filename>/etc</filename> or <filename>${bindir}</filename> rather |
567 | than <filename>/usr/bin</filename>. | 567 | than <filename>/usr/bin</filename>. |
568 | You can find a list of these variables at the top of the | 568 | You can find a list of these variables at the top of the |
569 | <filename>/meta/conf/bitbake.conf</filename> file in the | 569 | <filename>/meta/conf/bitbake.conf</filename> file in the |
570 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 570 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
571 | </note> | 571 | </note> |
572 | </glossdef> | 572 | </glossdef> |
@@ -575,9 +575,9 @@ Core layer for images cannot be removed | |||
575 | <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> | 575 | <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> |
576 | <glossdef> | 576 | <glossdef> |
577 | <para> | 577 | <para> |
578 | A list of files that contains <filename>autoconf</filename> test results relevant | 578 | A list of files that contains <filename>autoconf</filename> test results relevant |
579 | to the current build. | 579 | to the current build. |
580 | This variable is used by the Autotools utilities when running | 580 | This variable is used by the Autotools utilities when running |
581 | <filename>configure</filename>. | 581 | <filename>configure</filename>. |
582 | </para> | 582 | </para> |
583 | </glossdef> | 583 | </glossdef> |
@@ -586,9 +586,9 @@ Core layer for images cannot be removed | |||
586 | <glossentry id='var-CORE_IMAGE_EXTRA_INSTALL'><glossterm>CORE_IMAGE_EXTRA_INSTALL</glossterm> | 586 | <glossentry id='var-CORE_IMAGE_EXTRA_INSTALL'><glossterm>CORE_IMAGE_EXTRA_INSTALL</glossterm> |
587 | <glossdef> | 587 | <glossdef> |
588 | <para> | 588 | <para> |
589 | Specifies the list of packages to be added to the image. | 589 | Specifies the list of packages to be added to the image. |
590 | This variable should only be set in the <filename>local.conf</filename> | 590 | This variable should only be set in the <filename>local.conf</filename> |
591 | configuration file found in the | 591 | configuration file found in the |
592 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 592 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
593 | </para> | 593 | </para> |
594 | 594 | ||
@@ -611,9 +611,9 @@ Core layer for images cannot be removed | |||
611 | <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm> | 611 | <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm> |
612 | <glossdef> | 612 | <glossdef> |
613 | <para> | 613 | <para> |
614 | Specifies to build packages with debugging information. | 614 | Specifies to build packages with debugging information. |
615 | This influences the value of the | 615 | This influences the value of the |
616 | <filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename> | 616 | <filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename> |
617 | variable. | 617 | variable. |
618 | </para> | 618 | </para> |
619 | </glossdef> | 619 | </glossdef> |
@@ -622,9 +622,9 @@ Core layer for images cannot be removed | |||
622 | <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm> | 622 | <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm> |
623 | <glossdef> | 623 | <glossdef> |
624 | <para> | 624 | <para> |
625 | The options to pass in | 625 | The options to pass in |
626 | <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> | 626 | <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> |
627 | and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling | 627 | and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling |
628 | a system for debugging. | 628 | a system for debugging. |
629 | This variable defaults to "-O -fno-omit-frame-pointer -g". | 629 | This variable defaults to "-O -fno-omit-frame-pointer -g". |
630 | </para> | 630 | </para> |
@@ -641,9 +641,9 @@ Core layer for images cannot be removed | |||
641 | <glossdef> | 641 | <glossdef> |
642 | <para> | 642 | <para> |
643 | Lists a recipe's build-time dependencies | 643 | Lists a recipe's build-time dependencies |
644 | (i.e. other recipe files). | 644 | (i.e. other recipe files). |
645 | The system ensures that all the dependencies listed | 645 | The system ensures that all the dependencies listed |
646 | have been built and have their contents in the appropriate | 646 | have been built and have their contents in the appropriate |
647 | sysroots before the recipe's configure task is executed. | 647 | sysroots before the recipe's configure task is executed. |
648 | </para> | 648 | </para> |
649 | </glossdef> | 649 | </glossdef> |
@@ -652,8 +652,8 @@ Core layer for images cannot be removed | |||
652 | <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> | 652 | <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> |
653 | <glossdef> | 653 | <glossdef> |
654 | <para>The package description used by package managers. | 654 | <para>The package description used by package managers. |
655 | If not set, <filename>DESCRIPTION</filename> takes | 655 | If not set, <filename>DESCRIPTION</filename> takes |
656 | the value of the | 656 | the value of the |
657 | <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link> | 657 | <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link> |
658 | variable. | 658 | variable. |
659 | </para> | 659 | </para> |
@@ -669,11 +669,11 @@ Core layer for images cannot be removed | |||
669 | <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm> | 669 | <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm> |
670 | <glossdef> | 670 | <glossdef> |
671 | <para> | 671 | <para> |
672 | The short name of the distribution. | 672 | The short name of the distribution. |
673 | This variable corresponds to a file with the | 673 | This variable corresponds to a file with the |
674 | extension <filename>.conf</filename> | 674 | extension <filename>.conf</filename> |
675 | located in a <filename>conf/distro</filename> directory | 675 | located in a <filename>conf/distro</filename> directory |
676 | within the metadata that contains the distribution configuration. | 676 | within the metadata that contains the distribution configuration. |
677 | The | 677 | The |
678 | value must not contain spaces, and is typically all lower-case. | 678 | value must not contain spaces, and is typically all lower-case. |
679 | </para> | 679 | </para> |
@@ -689,11 +689,11 @@ Core layer for images cannot be removed | |||
689 | <glossdef> | 689 | <glossdef> |
690 | <para> | 690 | <para> |
691 | Specifies a list of distro-specific packages to add to all images. | 691 | Specifies a list of distro-specific packages to add to all images. |
692 | This variable takes affect through | 692 | This variable takes affect through |
693 | <filename>packagegroup-base</filename> so the | 693 | <filename>packagegroup-base</filename> so the |
694 | variable only really applies to the more full-featured | 694 | variable only really applies to the more full-featured |
695 | images that include <filename>packagegroup-base</filename>. | 695 | images that include <filename>packagegroup-base</filename>. |
696 | You can use this variable to keep distro policy out of | 696 | You can use this variable to keep distro policy out of |
697 | generic images. | 697 | generic images. |
698 | As with all other distro variables, you set this variable | 698 | As with all other distro variables, you set this variable |
699 | in the distro <filename>.conf</filename> file. | 699 | in the distro <filename>.conf</filename> file. |
@@ -704,10 +704,10 @@ Core layer for images cannot be removed | |||
704 | <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm> | 704 | <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm> |
705 | <glossdef> | 705 | <glossdef> |
706 | <para> | 706 | <para> |
707 | Specifies a list of distro-specific packages to add to all images | 707 | Specifies a list of distro-specific packages to add to all images |
708 | if the packages exist. | 708 | if the packages exist. |
709 | The packages might not exist or be empty (e.g. kernel modules). | 709 | The packages might not exist or be empty (e.g. kernel modules). |
710 | The list of packages are automatically installed but can be | 710 | The list of packages are automatically installed but can be |
711 | removed by the user. | 711 | removed by the user. |
712 | </para> | 712 | </para> |
713 | </glossdef> | 713 | </glossdef> |
@@ -725,18 +725,18 @@ Core layer for images cannot be removed | |||
725 | 725 | ||
726 | <glossentry id='var-DISTRO_FEATURES_BACKFILL'><glossterm>DISTRO_FEATURES_BACKFILL</glossterm> | 726 | <glossentry id='var-DISTRO_FEATURES_BACKFILL'><glossterm>DISTRO_FEATURES_BACKFILL</glossterm> |
727 | <glossdef> | 727 | <glossdef> |
728 | <para>Features to be added to | 728 | <para>Features to be added to |
729 | <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename> | 729 | <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename> |
730 | if not also present in | 730 | if not also present in |
731 | <filename><link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'>DISTRO_FEATURES_BACKFILL_CONSIDERED</link></filename>. | 731 | <filename><link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'>DISTRO_FEATURES_BACKFILL_CONSIDERED</link></filename>. |
732 | </para> | 732 | </para> |
733 | 733 | ||
734 | <para> | 734 | <para> |
735 | This variable is set in the <filename>meta/conf/bitbake.conf</filename> file. | 735 | This variable is set in the <filename>meta/conf/bitbake.conf</filename> file. |
736 | It is not intended to be user-configurable. | 736 | It is not intended to be user-configurable. |
737 | It is best to just reference the variable to see which distro features are | 737 | It is best to just reference the variable to see which distro features are |
738 | being backfilled for all distro configurations. | 738 | being backfilled for all distro configurations. |
739 | See the <link linkend='ref-features-backfill'>Feature backfilling</link> section for | 739 | See the <link linkend='ref-features-backfill'>Feature backfilling</link> section for |
740 | more information. | 740 | more information. |
741 | </para> | 741 | </para> |
742 | </glossdef> | 742 | </glossdef> |
@@ -749,7 +749,7 @@ Core layer for images cannot be removed | |||
749 | that should not backfilled (i.e. added to | 749 | that should not backfilled (i.e. added to |
750 | <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>) | 750 | <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>) |
751 | during the build. | 751 | during the build. |
752 | See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for | 752 | See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for |
753 | more information. | 753 | more information. |
754 | </para> | 754 | </para> |
755 | </glossdef> | 755 | </glossdef> |
@@ -764,9 +764,9 @@ Core layer for images cannot be removed | |||
764 | <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm> | 764 | <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm> |
765 | <glossdef> | 765 | <glossdef> |
766 | <para>Alias names used for the recipe in various Linux distributions.</para> | 766 | <para>Alias names used for the recipe in various Linux distributions.</para> |
767 | <para>See the | 767 | <para>See the |
768 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-DISTRO_PN_ALIAS'>Handling | 768 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-DISTRO_PN_ALIAS'>Handling |
769 | a Package Name Alias</ulink>" section in the Yocto Project Development | 769 | a Package Name Alias</ulink>" section in the Yocto Project Development |
770 | Manual for more information.</para> | 770 | Manual for more information.</para> |
771 | </glossdef> | 771 | </glossdef> |
772 | </glossentry> | 772 | </glossentry> |
@@ -784,8 +784,8 @@ Core layer for images cannot be removed | |||
784 | You can set this directory by defining the <filename>DL_DIR</filename> | 784 | You can set this directory by defining the <filename>DL_DIR</filename> |
785 | variable in the <filename>/conf/local.conf</filename> file. | 785 | variable in the <filename>/conf/local.conf</filename> file. |
786 | This directory is self-maintaining and you should not have | 786 | This directory is self-maintaining and you should not have |
787 | to touch it. | 787 | to touch it. |
788 | By default, the directory is <filename>downloads</filename> in the | 788 | By default, the directory is <filename>downloads</filename> in the |
789 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 789 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
790 | <literallayout class='monospaced'> | 790 | <literallayout class='monospaced'> |
791 | #DL_DIR ?= "${TOPDIR}/downloads" | 791 | #DL_DIR ?= "${TOPDIR}/downloads" |
@@ -795,22 +795,22 @@ Core layer for images cannot be removed | |||
795 | </para> | 795 | </para> |
796 | 796 | ||
797 | <para> | 797 | <para> |
798 | During a first build, the system downloads many different source code | 798 | During a first build, the system downloads many different source code |
799 | tarballs from various upstream projects. | 799 | tarballs from various upstream projects. |
800 | Downloading can take a while, particularly if your network | 800 | Downloading can take a while, particularly if your network |
801 | connection is slow. | 801 | connection is slow. |
802 | Tarballs are all stored in the directory defined by | 802 | Tarballs are all stored in the directory defined by |
803 | <filename>DL_DIR</filename> and the build system looks there first | 803 | <filename>DL_DIR</filename> and the build system looks there first |
804 | to find source tarballs. | 804 | to find source tarballs. |
805 | <note> | 805 | <note> |
806 | When wiping and rebuilding, you can preserve this directory to speed | 806 | When wiping and rebuilding, you can preserve this directory to speed |
807 | up this part of subsequent builds. | 807 | up this part of subsequent builds. |
808 | </note> | 808 | </note> |
809 | </para> | 809 | </para> |
810 | 810 | ||
811 | <para> | 811 | <para> |
812 | You can safely share this directory between multiple builds on the | 812 | You can safely share this directory between multiple builds on the |
813 | same development machine. | 813 | same development machine. |
814 | For additional information on how the build process gets source files | 814 | For additional information on how the build process gets source files |
815 | when working behind a firewall or proxy server, see the | 815 | when working behind a firewall or proxy server, see the |
816 | "<link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>FAQ</link>" | 816 | "<link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>FAQ</link>" |
@@ -836,15 +836,15 @@ Core layer for images cannot be removed | |||
836 | <glossdef> | 836 | <glossdef> |
837 | <para> | 837 | <para> |
838 | Used with file and pathnames to create a prefix for a recipe's | 838 | Used with file and pathnames to create a prefix for a recipe's |
839 | version based on the recipe's | 839 | version based on the recipe's |
840 | <link linkend='var-PE'><filename>PE</filename></link> value. | 840 | <link linkend='var-PE'><filename>PE</filename></link> value. |
841 | If <filename>PE</filename> is set and greater than zero for a recipe, | 841 | If <filename>PE</filename> is set and greater than zero for a recipe, |
842 | <filename>EXTENDPE</filename> becomes that value (e.g if | 842 | <filename>EXTENDPE</filename> becomes that value (e.g if |
843 | <filename>PE</filename> is equal to "1" then <filename>EXTENDPE</filename> | 843 | <filename>PE</filename> is equal to "1" then <filename>EXTENDPE</filename> |
844 | becomes "1_"). | 844 | becomes "1_"). |
845 | If a recipe's <filename>PE</filename> is not set (the default) or is equal to | 845 | If a recipe's <filename>PE</filename> is not set (the default) or is equal to |
846 | zero, <filename>EXTENDPE</filename> becomes "".</para> | 846 | zero, <filename>EXTENDPE</filename> becomes "".</para> |
847 | <para>See the <link linkend='var-STAMP'><filename>STAMP</filename></link> | 847 | <para>See the <link linkend='var-STAMP'><filename>STAMP</filename></link> |
848 | variable for an example. | 848 | variable for an example. |
849 | </para> | 849 | </para> |
850 | </glossdef> | 850 | </glossdef> |
@@ -855,38 +855,38 @@ Core layer for images cannot be removed | |||
855 | <para>Allows extra packages to be added to the generated images. | 855 | <para>Allows extra packages to be added to the generated images. |
856 | You set this variable in the <filename>local.conf</filename> | 856 | You set this variable in the <filename>local.conf</filename> |
857 | configuration file. | 857 | configuration file. |
858 | Note that some image features are also added using the | 858 | Note that some image features are also added using the |
859 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> | 859 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> |
860 | variable generally configured in image recipes. | 860 | variable generally configured in image recipes. |
861 | You can use this variable to add more features in addition to those. | 861 | You can use this variable to add more features in addition to those. |
862 | Here are some examples of features you can add:</para> | 862 | Here are some examples of features you can add:</para> |
863 | <literallayout class='monospaced'> | 863 | <literallayout class='monospaced'> |
864 | "dbg-pkgs" - Adds -dbg packages for all installed packages | 864 | "dbg-pkgs" - Adds -dbg packages for all installed packages |
865 | including symbol information for debugging and | 865 | including symbol information for debugging and |
866 | profiling. | 866 | profiling. |
867 | 867 | ||
868 | "dev-pkgs" - Adds -dev packages for all installed packages. | 868 | "dev-pkgs" - Adds -dev packages for all installed packages. |
869 | This is useful if you want to develop against | 869 | This is useful if you want to develop against |
870 | the libraries in the image. | 870 | the libraries in the image. |
871 | 871 | ||
872 | "tools-sdk" - Adds development tools such as gcc, make, | 872 | "tools-sdk" - Adds development tools such as gcc, make, |
873 | pkgconfig and so forth. | 873 | pkgconfig and so forth. |
874 | 874 | ||
875 | "tools-debug" - Adds debugging tools such as gdb and | 875 | "tools-debug" - Adds debugging tools such as gdb and |
876 | strace. | 876 | strace. |
877 | 877 | ||
878 | "tools-profile" - Adds profiling tools such as oprofile, | 878 | "tools-profile" - Adds profiling tools such as oprofile, |
879 | exmap, lttng and valgrind (x86 only). | 879 | exmap, lttng and valgrind (x86 only). |
880 | 880 | ||
881 | "tools-testapps" - Adds useful testing tools such as | 881 | "tools-testapps" - Adds useful testing tools such as |
882 | ts_print, aplay, arecord and so | 882 | ts_print, aplay, arecord and so |
883 | forth. | 883 | forth. |
884 | 884 | ||
885 | "debug-tweaks" - Makes an image suitable for development. | 885 | "debug-tweaks" - Makes an image suitable for development. |
886 | For example, ssh root access has a blank | 886 | For example, ssh root access has a blank |
887 | password. You should remove this feature | 887 | password. You should remove this feature |
888 | before you produce a production image. | 888 | before you produce a production image. |
889 | </literallayout> | 889 | </literallayout> |
890 | 890 | ||
891 | <para>There are other valid features too, see the | 891 | <para>There are other valid features too, see the |
892 | <link linkend='ref-features-image'>Images</link> | 892 | <link linkend='ref-features-image'>Images</link> |
@@ -901,12 +901,12 @@ Core layer for images cannot be removed | |||
901 | </para> | 901 | </para> |
902 | <para>Sometimes a recipe is required to build the final image but is not | 902 | <para>Sometimes a recipe is required to build the final image but is not |
903 | needed in the root filesystem. | 903 | needed in the root filesystem. |
904 | You can use the <filename>EXTRA_IMAGEDEPENDS</filename> variable to | 904 | You can use the <filename>EXTRA_IMAGEDEPENDS</filename> variable to |
905 | list these recipes and thus, specify the dependencies. | 905 | list these recipes and thus, specify the dependencies. |
906 | A typical example is a required bootloader in a machine configuration. | 906 | A typical example is a required bootloader in a machine configuration. |
907 | </para> | 907 | </para> |
908 | <note> | 908 | <note> |
909 | To add packages to the root filesystem, see the various | 909 | To add packages to the root filesystem, see the various |
910 | <filename>*DEPENDS</filename> and <filename>*RECOMMENDS</filename> | 910 | <filename>*DEPENDS</filename> and <filename>*RECOMMENDS</filename> |
911 | variables. | 911 | variables. |
912 | </note> | 912 | </note> |
@@ -944,32 +944,32 @@ Core layer for images cannot be removed | |||
944 | <para> | 944 | <para> |
945 | To use the <filename>FILES</filename> variable, provide a package name | 945 | To use the <filename>FILES</filename> variable, provide a package name |
946 | override that identifies the resulting package. | 946 | override that identifies the resulting package. |
947 | Then, provide a space-separated list of files or paths that identifies the | 947 | Then, provide a space-separated list of files or paths that identifies the |
948 | files you want included as part of the resulting package. | 948 | files you want included as part of the resulting package. |
949 | Here is an example: | 949 | Here is an example: |
950 | <literallayout class='monospaced'> | 950 | <literallayout class='monospaced'> |
951 | FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile" | 951 | FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile" |
952 | </literallayout> | 952 | </literallayout> |
953 | </para> | 953 | </para> |
954 | 954 | ||
955 | <note> | 955 | <note> |
956 | When specifying paths as part of the <filename>FILES</filename> variable, | 956 | When specifying paths as part of the <filename>FILES</filename> variable, |
957 | it is good practice to use appropriate path variables. | 957 | it is good practice to use appropriate path variables. |
958 | For example, <filename>${sysconfdir}</filename> rather than | 958 | For example, <filename>${sysconfdir}</filename> rather than |
959 | <filename>/etc</filename> or <filename>${bindir}</filename> rather | 959 | <filename>/etc</filename> or <filename>${bindir}</filename> rather |
960 | than <filename>/usr/bin</filename>. | 960 | than <filename>/usr/bin</filename>. |
961 | You can find a list of these variables at the top of the | 961 | You can find a list of these variables at the top of the |
962 | <filename>/meta/conf/bitbake.conf</filename> file in the | 962 | <filename>/meta/conf/bitbake.conf</filename> file in the |
963 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 963 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
964 | </note> | 964 | </note> |
965 | 965 | ||
966 | <para> | 966 | <para> |
967 | If some of the files you provide with the <filename>FILES</filename> variable | 967 | If some of the files you provide with the <filename>FILES</filename> variable |
968 | are editable and you know they should not be | 968 | are editable and you know they should not be |
969 | overwritten during the package update process by the Package Management | 969 | overwritten during the package update process by the Package Management |
970 | System (PMS), you can identify these files so that the PMS will not | 970 | System (PMS), you can identify these files so that the PMS will not |
971 | overwrite them. | 971 | overwrite them. |
972 | See the <filename><link linkend='var-CONFFILES'>CONFFILES</link></filename> | 972 | See the <filename><link linkend='var-CONFFILES'>CONFFILES</link></filename> |
973 | variable for information on how to identify these files to the PMS. | 973 | variable for information on how to identify these files to the PMS. |
974 | </para> | 974 | </para> |
975 | 975 | ||
@@ -979,11 +979,11 @@ Core layer for images cannot be removed | |||
979 | <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm> | 979 | <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm> |
980 | <glossdef> | 980 | <glossdef> |
981 | <para> | 981 | <para> |
982 | Extends the search path the OpenEmbedded build system uses when | 982 | Extends the search path the OpenEmbedded build system uses when |
983 | looking for files and patches as it processes recipes. | 983 | looking for files and patches as it processes recipes. |
984 | The directories BitBake uses when it processes recipes is defined by the | 984 | The directories BitBake uses when it processes recipes is defined by the |
985 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> variable. | 985 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> variable. |
986 | You can add directories to the search path by defining the | 986 | You can add directories to the search path by defining the |
987 | <filename>FILESEXTRAPATHS</filename> variable. | 987 | <filename>FILESEXTRAPATHS</filename> variable. |
988 | </para> | 988 | </para> |
989 | 989 | ||
@@ -993,17 +993,17 @@ Core layer for images cannot be removed | |||
993 | <literallayout class='monospaced'> | 993 | <literallayout class='monospaced'> |
994 | FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" | 994 | FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" |
995 | </literallayout> | 995 | </literallayout> |
996 | Typically, you want your directories searched first. | 996 | Typically, you want your directories searched first. |
997 | To make sure that happens, use <filename>_prepend</filename> and | 997 | To make sure that happens, use <filename>_prepend</filename> and |
998 | the immediate expansion (<filename>:=</filename>) operator as shown in the | 998 | the immediate expansion (<filename>:=</filename>) operator as shown in the |
999 | previous example. | 999 | previous example. |
1000 | Finally, to maintain the integrity of the <filename>FILESPATH</filename> variable, | 1000 | Finally, to maintain the integrity of the <filename>FILESPATH</filename> variable, |
1001 | you must include the appropriate beginning or ending (as needed) colon character. | 1001 | you must include the appropriate beginning or ending (as needed) colon character. |
1002 | </para> | 1002 | </para> |
1003 | 1003 | ||
1004 | <para> | 1004 | <para> |
1005 | The <filename>FILESEXTRAPATHS</filename> variable is intended for use in | 1005 | The <filename>FILESEXTRAPATHS</filename> variable is intended for use in |
1006 | <filename>.bbappend</filename> files to include any additional files provided in that layer. | 1006 | <filename>.bbappend</filename> files to include any additional files provided in that layer. |
1007 | You typically accomplish this with the following: | 1007 | You typically accomplish this with the following: |
1008 | <literallayout class='monospaced'> | 1008 | <literallayout class='monospaced'> |
1009 | FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" | 1009 | FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" |
@@ -1017,15 +1017,15 @@ Core layer for images cannot be removed | |||
1017 | <para> | 1017 | <para> |
1018 | The default set of directories the OpenEmbedded build system uses | 1018 | The default set of directories the OpenEmbedded build system uses |
1019 | when searching for patches and files. | 1019 | when searching for patches and files. |
1020 | During the build process, BitBake searches each directory in | 1020 | During the build process, BitBake searches each directory in |
1021 | <filename>FILESPATH</filename> in the specified order when looking for | 1021 | <filename>FILESPATH</filename> in the specified order when looking for |
1022 | files and patches specified by each <filename>file://</filename> URI in a recipe. | 1022 | files and patches specified by each <filename>file://</filename> URI in a recipe. |
1023 | </para> | 1023 | </para> |
1024 | 1024 | ||
1025 | <para> | 1025 | <para> |
1026 | The default value for the <filename>FILESPATH</filename> variable is defined | 1026 | The default value for the <filename>FILESPATH</filename> variable is defined |
1027 | in the <filename>base.bbclass</filename> class found in | 1027 | in the <filename>base.bbclass</filename> class found in |
1028 | <filename>meta/classes</filename> in the | 1028 | <filename>meta/classes</filename> in the |
1029 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: | 1029 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: |
1030 | <literallayout class='monospaced'> | 1030 | <literallayout class='monospaced'> |
1031 | FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | 1031 | FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ |
@@ -1033,9 +1033,9 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1033 | "${FILE_DIRNAME}/${BP}", "${FILE_DIRNAME}/${BPN}", \ | 1033 | "${FILE_DIRNAME}/${BP}", "${FILE_DIRNAME}/${BPN}", \ |
1034 | "${FILE_DIRNAME}/files", "${FILE_DIRNAME}" ], d)}" | 1034 | "${FILE_DIRNAME}/files", "${FILE_DIRNAME}" ], d)}" |
1035 | </literallayout> | 1035 | </literallayout> |
1036 | Do not hand-edit the <filename>FILESPATH</filename> variable. | 1036 | Do not hand-edit the <filename>FILESPATH</filename> variable. |
1037 | If you want to extend the set of pathnames that BitBake uses when searching for | 1037 | If you want to extend the set of pathnames that BitBake uses when searching for |
1038 | files and patches, use the | 1038 | files and patches, use the |
1039 | <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> variable. | 1039 | <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> variable. |
1040 | </para> | 1040 | </para> |
1041 | </glossdef> | 1041 | </glossdef> |
@@ -1045,29 +1045,29 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1045 | <glossdef> | 1045 | <glossdef> |
1046 | <para>Allows you to define your own file permissions settings table as part of | 1046 | <para>Allows you to define your own file permissions settings table as part of |
1047 | your configuration for the packaging process. | 1047 | your configuration for the packaging process. |
1048 | For example, suppose you need a consistent set of custom permissions for | 1048 | For example, suppose you need a consistent set of custom permissions for |
1049 | a set of groups and users across an entire work project. | 1049 | a set of groups and users across an entire work project. |
1050 | It is best to do this in the packages themselves but this is not always | 1050 | It is best to do this in the packages themselves but this is not always |
1051 | possible. | 1051 | possible. |
1052 | </para> | 1052 | </para> |
1053 | <para> | 1053 | <para> |
1054 | By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which | 1054 | By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which |
1055 | is located in the <filename>meta/files</filename> folder in the | 1055 | is located in the <filename>meta/files</filename> folder in the |
1056 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 1056 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
1057 | If you create your own file permissions setting table, you should place it in your | 1057 | If you create your own file permissions setting table, you should place it in your |
1058 | layer or the distros layer. | 1058 | layer or the distros layer. |
1059 | </para> | 1059 | </para> |
1060 | <para> | 1060 | <para> |
1061 | You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the | 1061 | You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the |
1062 | <filename>conf/local.conf</filename> file, which is found in the | 1062 | <filename>conf/local.conf</filename> file, which is found in the |
1063 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to | 1063 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to |
1064 | point to your custom <filename>fs-perms.txt</filename>. | 1064 | point to your custom <filename>fs-perms.txt</filename>. |
1065 | You can specify more than a single file permissions setting table. | 1065 | You can specify more than a single file permissions setting table. |
1066 | The paths you specify to these files must be defined within the | 1066 | The paths you specify to these files must be defined within the |
1067 | <filename>BBPATH</filename> variable. | 1067 | <filename>BBPATH</filename> variable. |
1068 | </para> | 1068 | </para> |
1069 | <para> | 1069 | <para> |
1070 | For guidance on how to create your own file permissions settings table file, | 1070 | For guidance on how to create your own file permissions settings table file, |
1071 | examine the existing <filename>fs-perms.txt</filename>. | 1071 | examine the existing <filename>fs-perms.txt</filename>. |
1072 | </para> | 1072 | </para> |
1073 | </glossdef> | 1073 | </glossdef> |
@@ -1076,11 +1076,11 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1076 | <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm> | 1076 | <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm> |
1077 | <glossdef> | 1077 | <glossdef> |
1078 | <para> | 1078 | <para> |
1079 | The options to pass in | 1079 | The options to pass in |
1080 | <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> | 1080 | <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> |
1081 | and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> | 1081 | and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> |
1082 | when compiling an optimized system. | 1082 | when compiling an optimized system. |
1083 | This variable defaults to | 1083 | This variable defaults to |
1084 | "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2". | 1084 | "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2". |
1085 | </para> | 1085 | </para> |
1086 | </glossdef> | 1086 | </glossdef> |
@@ -1110,7 +1110,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1110 | Typically, you configure this variable in an image recipe. | 1110 | Typically, you configure this variable in an image recipe. |
1111 | Note that you can also add extra features to the image by using the | 1111 | Note that you can also add extra features to the image by using the |
1112 | <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. | 1112 | <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. |
1113 | See the "<link linkend="ref-features-image">Images</link>" section for the | 1113 | See the "<link linkend="ref-features-image">Images</link>" section for the |
1114 | full list of features that can be included in images built by the | 1114 | full list of features that can be included in images built by the |
1115 | OpenEmbedded build system.</para> | 1115 | OpenEmbedded build system.</para> |
1116 | </glossdef> | 1116 | </glossdef> |
@@ -1131,28 +1131,28 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1131 | </para> | 1131 | </para> |
1132 | 1132 | ||
1133 | <para> | 1133 | <para> |
1134 | Image recipes set <filename>IMAGE_INSTALL</filename> to specify the | 1134 | Image recipes set <filename>IMAGE_INSTALL</filename> to specify the |
1135 | packages to install into an image through <filename>image.bbclass</filename>. | 1135 | packages to install into an image through <filename>image.bbclass</filename>. |
1136 | Additionally, "helper" classes exist, such as <filename>core-image.bbclass</filename>, | 1136 | Additionally, "helper" classes exist, such as <filename>core-image.bbclass</filename>, |
1137 | that can take | 1137 | that can take |
1138 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> lists | 1138 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> lists |
1139 | and turn these into auto-generated entries in | 1139 | and turn these into auto-generated entries in |
1140 | <filename>IMAGE_INSTALL</filename> in addition to its default contents. | 1140 | <filename>IMAGE_INSTALL</filename> in addition to its default contents. |
1141 | </para> | 1141 | </para> |
1142 | 1142 | ||
1143 | <para> | 1143 | <para> |
1144 | Using <filename>IMAGE_INSTALL</filename> with the <filename>+=</filename> | 1144 | Using <filename>IMAGE_INSTALL</filename> with the <filename>+=</filename> |
1145 | operator from the <filename>/conf/local.conf</filename> file or from within | 1145 | operator from the <filename>/conf/local.conf</filename> file or from within |
1146 | an image recipe is not recommended as it can cause ordering issues. | 1146 | an image recipe is not recommended as it can cause ordering issues. |
1147 | Since <filename>core-image.bbclass</filename> sets <filename>IMAGE_INSTALL</filename> | 1147 | Since <filename>core-image.bbclass</filename> sets <filename>IMAGE_INSTALL</filename> |
1148 | to a default value using the <filename>?=</filename> operator, using a | 1148 | to a default value using the <filename>?=</filename> operator, using a |
1149 | <filename>+=</filename> operation against <filename>IMAGE_INSTALL</filename> | 1149 | <filename>+=</filename> operation against <filename>IMAGE_INSTALL</filename> |
1150 | will result in unexpected behavior when used in | 1150 | will result in unexpected behavior when used in |
1151 | <filename>/conf/local.conf</filename>. | 1151 | <filename>/conf/local.conf</filename>. |
1152 | Furthermore, the same operation from with an image recipe may or may not | 1152 | Furthermore, the same operation from with an image recipe may or may not |
1153 | succeed depending on the specific situation. | 1153 | succeed depending on the specific situation. |
1154 | In both these cases, the behavior is contrary to how most users expect | 1154 | In both these cases, the behavior is contrary to how most users expect |
1155 | the <filename>+=</filename> operator to work. | 1155 | the <filename>+=</filename> operator to work. |
1156 | </para> | 1156 | </para> |
1157 | 1157 | ||
1158 | <para> | 1158 | <para> |
@@ -1171,27 +1171,27 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1171 | <para> | 1171 | <para> |
1172 | Defines a multiplier that the build system applies to the initial image | 1172 | Defines a multiplier that the build system applies to the initial image |
1173 | size for cases when the multiplier times the returned disk usage value | 1173 | size for cases when the multiplier times the returned disk usage value |
1174 | for the image is greater than the sum of | 1174 | for the image is greater than the sum of |
1175 | <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename> | 1175 | <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename> |
1176 | and | 1176 | and |
1177 | <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>. | 1177 | <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>. |
1178 | The result of the multiplier applied to the initial image size creates | 1178 | The result of the multiplier applied to the initial image size creates |
1179 | free disk space in the image as overhead. | 1179 | free disk space in the image as overhead. |
1180 | By default, the build process uses a multiplier of 1.3 for this variable. | 1180 | By default, the build process uses a multiplier of 1.3 for this variable. |
1181 | This default value results in 30% free disk space added to the image when this | 1181 | This default value results in 30% free disk space added to the image when this |
1182 | method is used to determine the final generated image size. | 1182 | method is used to determine the final generated image size. |
1183 | You should be aware that post install scripts and the package management | 1183 | You should be aware that post install scripts and the package management |
1184 | system uses disk space inside this overhead area. | 1184 | system uses disk space inside this overhead area. |
1185 | Consequently, the multiplier does not produce an image with | 1185 | Consequently, the multiplier does not produce an image with |
1186 | all the theoretical free disk space. | 1186 | all the theoretical free disk space. |
1187 | See <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename> | 1187 | See <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename> |
1188 | for information on how the build system determines the overall image size. | 1188 | for information on how the build system determines the overall image size. |
1189 | </para> | 1189 | </para> |
1190 | 1190 | ||
1191 | <para> | 1191 | <para> |
1192 | The default 30% free disk space typically gives the image enough room to boot | 1192 | The default 30% free disk space typically gives the image enough room to boot |
1193 | and allows for basic post installs while still leaving a small amount of | 1193 | and allows for basic post installs while still leaving a small amount of |
1194 | free disk space. | 1194 | free disk space. |
1195 | If 30% free space is inadequate, you can increase the default value. | 1195 | If 30% free space is inadequate, you can increase the default value. |
1196 | For example, the following setting gives you 50% free space added to the image: | 1196 | For example, the following setting gives you 50% free space added to the image: |
1197 | <literallayout class='monospaced'> | 1197 | <literallayout class='monospaced'> |
@@ -1201,12 +1201,12 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1201 | 1201 | ||
1202 | <para> | 1202 | <para> |
1203 | Alternatively, you can ensure a specific amount of free disk space is added | 1203 | Alternatively, you can ensure a specific amount of free disk space is added |
1204 | to the image by using | 1204 | to the image by using |
1205 | <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename> | 1205 | <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename> |
1206 | the variable. | 1206 | the variable. |
1207 | </para> | 1207 | </para> |
1208 | </glossdef> | 1208 | </glossdef> |
1209 | </glossentry> | 1209 | </glossentry> |
1210 | 1210 | ||
1211 | <glossentry id='var-IMAGE_ROOTFS_EXTRA_SPACE'><glossterm>IMAGE_ROOTFS_EXTRA_SPACE</glossterm> | 1211 | <glossentry id='var-IMAGE_ROOTFS_EXTRA_SPACE'><glossterm>IMAGE_ROOTFS_EXTRA_SPACE</glossterm> |
1212 | <glossdef> | 1212 | <glossdef> |
@@ -1214,32 +1214,32 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1214 | Defines additional free disk space created in the image in Kbytes. | 1214 | Defines additional free disk space created in the image in Kbytes. |
1215 | By default, this variable is set to "0". | 1215 | By default, this variable is set to "0". |
1216 | This free disk space is added to the image after the build system determines | 1216 | This free disk space is added to the image after the build system determines |
1217 | the image size as described in | 1217 | the image size as described in |
1218 | <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>. | 1218 | <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>. |
1219 | </para> | 1219 | </para> |
1220 | 1220 | ||
1221 | <para> | 1221 | <para> |
1222 | This variable is particularly useful when you want to ensure that a | 1222 | This variable is particularly useful when you want to ensure that a |
1223 | specific amount of free disk space is available on a device after an image | 1223 | specific amount of free disk space is available on a device after an image |
1224 | is installed and running. | 1224 | is installed and running. |
1225 | For example, to be sure 5 Gbytes of free disk space is available, set the | 1225 | For example, to be sure 5 Gbytes of free disk space is available, set the |
1226 | variable as follows: | 1226 | variable as follows: |
1227 | <literallayout class='monospaced'> | 1227 | <literallayout class='monospaced'> |
1228 | IMAGE_ROOTFS_EXTRA_SPACE = "5242880" | 1228 | IMAGE_ROOTFS_EXTRA_SPACE = "5242880" |
1229 | </literallayout> | 1229 | </literallayout> |
1230 | </para> | 1230 | </para> |
1231 | </glossdef> | 1231 | </glossdef> |
1232 | </glossentry> | 1232 | </glossentry> |
1233 | 1233 | ||
1234 | <glossentry id='var-IMAGE_ROOTFS_SIZE'><glossterm>IMAGE_ROOTFS_SIZE</glossterm> | 1234 | <glossentry id='var-IMAGE_ROOTFS_SIZE'><glossterm>IMAGE_ROOTFS_SIZE</glossterm> |
1235 | <glossdef> | 1235 | <glossdef> |
1236 | <para> | 1236 | <para> |
1237 | Defines the size in Kbytes for the generated image. | 1237 | Defines the size in Kbytes for the generated image. |
1238 | The OpenEmbedded build system determines the final size for the generated | 1238 | The OpenEmbedded build system determines the final size for the generated |
1239 | image using an algorithm that takes into account the initial disk space used | 1239 | image using an algorithm that takes into account the initial disk space used |
1240 | for the generated image, a requested size for the image, and requested | 1240 | for the generated image, a requested size for the image, and requested |
1241 | additional free disk space to be added to the image. | 1241 | additional free disk space to be added to the image. |
1242 | Programatically, the build system determines the final size of the | 1242 | Programatically, the build system determines the final size of the |
1243 | generated image as follows: | 1243 | generated image as follows: |
1244 | <literallayout class='monospaced'> | 1244 | <literallayout class='monospaced'> |
1245 | if (image-du * overhead) < rootfs-size: | 1245 | if (image-du * overhead) < rootfs-size: |
@@ -1251,7 +1251,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1251 | 1251 | ||
1252 | image-du = Returned value of the du command on | 1252 | image-du = Returned value of the du command on |
1253 | the image. | 1253 | the image. |
1254 | 1254 | ||
1255 | overhead = IMAGE_OVERHEAD_FACTOR | 1255 | overhead = IMAGE_OVERHEAD_FACTOR |
1256 | 1256 | ||
1257 | rootfs-size = IMAGE_ROOTFS_SIZE | 1257 | rootfs-size = IMAGE_ROOTFS_SIZE |
@@ -1261,12 +1261,12 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1261 | 1261 | ||
1262 | xspace = IMAGE_ROOTFS_EXTRA_SPACE | 1262 | xspace = IMAGE_ROOTFS_EXTRA_SPACE |
1263 | </literallayout> | 1263 | </literallayout> |
1264 | <!-- In the above example, <filename>overhead</filename> is defined by the | 1264 | <!-- In the above example, <filename>overhead</filename> is defined by the |
1265 | <filename><link linkend='var-IMAGE_OVERHEAD_FACTOR'>IMAGE_OVERHEAD_FACTOR</link></filename> | 1265 | <filename><link linkend='var-IMAGE_OVERHEAD_FACTOR'>IMAGE_OVERHEAD_FACTOR</link></filename> |
1266 | variable, <filename>xspace</filename> is defined by the | 1266 | variable, <filename>xspace</filename> is defined by the |
1267 | <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename> | 1267 | <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename> |
1268 | variable, and <filename>du</filename> is the results of the disk usage command | 1268 | variable, and <filename>du</filename> is the results of the disk usage command |
1269 | on the initially generated image. --> | 1269 | on the initially generated image. --> |
1270 | </para> | 1270 | </para> |
1271 | </glossdef> | 1271 | </glossdef> |
1272 | </glossentry> | 1272 | </glossentry> |
@@ -1275,38 +1275,38 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ | |||
1275 | <glossdef> | 1275 | <glossdef> |
1276 | <para>Helps define the recipe revision for recipes that share | 1276 | <para>Helps define the recipe revision for recipes that share |
1277 | a common <filename>include</filename> file. | 1277 | a common <filename>include</filename> file. |
1278 | You can think of this variable as part of the recipe revision | 1278 | You can think of this variable as part of the recipe revision |
1279 | as set from within an include file.</para> | 1279 | as set from within an include file.</para> |
1280 | <para>Suppose, for example, you have a set of recipes that | 1280 | <para>Suppose, for example, you have a set of recipes that |
1281 | are used across several projects. | 1281 | are used across several projects. |
1282 | And, within each of those recipes the revision | 1282 | And, within each of those recipes the revision |
1283 | (its <filename>PR</filename> value) is set accordingly. | 1283 | (its <filename>PR</filename> value) is set accordingly. |
1284 | In this case, when the revision of those recipes changes | 1284 | In this case, when the revision of those recipes changes |
1285 | the burden is on you to find all those recipes and | 1285 | the burden is on you to find all those recipes and |
1286 | be sure that they get changed to reflect the updated | 1286 | be sure that they get changed to reflect the updated |
1287 | version of the recipe. | 1287 | version of the recipe. |
1288 | In this scenario, it can get complicated when recipes | 1288 | In this scenario, it can get complicated when recipes |
1289 | used in many places and that provide common functionality | 1289 | used in many places and that provide common functionality |
1290 | are upgraded to a new revision.</para> | 1290 | are upgraded to a new revision.</para> |
1291 | <para>A more efficient way of dealing with this situation is | 1291 | <para>A more efficient way of dealing with this situation is |
1292 | to set the <filename>INC_PR</filename> variable inside | 1292 | to set the <filename>INC_PR</filename> variable inside |
1293 | the <filename>include</filename> files that the recipes | 1293 | the <filename>include</filename> files that the recipes |
1294 | share and then expand the <filename>INC_PR</filename> | 1294 | share and then expand the <filename>INC_PR</filename> |
1295 | variable within the recipes to help | 1295 | variable within the recipes to help |
1296 | define the recipe revision. | 1296 | define the recipe revision. |
1297 | </para> | 1297 | </para> |
1298 | <para> | 1298 | <para> |
1299 | The following provides an example that shows how to use | 1299 | The following provides an example that shows how to use |
1300 | the <filename>INC_PR</filename> variable | 1300 | the <filename>INC_PR</filename> variable |
1301 | given a common <filename>include</filename> file that | 1301 | given a common <filename>include</filename> file that |
1302 | defines the variable. | 1302 | defines the variable. |
1303 | Once the variable is defined in the | 1303 | Once the variable is defined in the |
1304 | <filename>include</filename> file, you can use the | 1304 | <filename>include</filename> file, you can use the |
1305 | variable to set the <filename>PR</filename> values in | 1305 | variable to set the <filename>PR</filename> values in |
1306 | each recipe. | 1306 | each recipe. |
1307 | You will notice that when you set a recipe's | 1307 | You will notice that when you set a recipe's |
1308 | <filename>PR</filename> you can provide more granular | 1308 | <filename>PR</filename> you can provide more granular |
1309 | revisioning by appending values to the | 1309 | revisioning by appending values to the |
1310 | <filename>INC_PR</filename> variable: | 1310 | <filename>INC_PR</filename> variable: |
1311 | <literallayout class='monospaced'> | 1311 | <literallayout class='monospaced'> |
1312 | recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" | 1312 | recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" |
@@ -1314,8 +1314,8 @@ recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1" | |||
1314 | recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0" | 1314 | recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0" |
1315 | recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | 1315 | recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" |
1316 | </literallayout> | 1316 | </literallayout> |
1317 | The first line of the example establishes the baseline | 1317 | The first line of the example establishes the baseline |
1318 | revision to be used for all recipes that use the | 1318 | revision to be used for all recipes that use the |
1319 | <filename>include</filename> file. | 1319 | <filename>include</filename> file. |
1320 | The remaining lines in the example are from individual | 1320 | The remaining lines in the example are from individual |
1321 | recipes and show how the <filename>PR</filename> value | 1321 | recipes and show how the <filename>PR</filename> value |
@@ -1335,8 +1335,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1335 | <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> | 1335 | <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> |
1336 | <glossdef> | 1336 | <glossdef> |
1337 | <para> | 1337 | <para> |
1338 | Causes the named class to be inherited at | 1338 | Causes the named class to be inherited at |
1339 | this point during parsing. | 1339 | this point during parsing. |
1340 | The variable is only valid in configuration files. | 1340 | The variable is only valid in configuration files. |
1341 | </para> | 1341 | </para> |
1342 | </glossdef> | 1342 | </glossdef> |
@@ -1346,8 +1346,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1346 | <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm> | 1346 | <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm> |
1347 | <glossdef> | 1347 | <glossdef> |
1348 | <para> | 1348 | <para> |
1349 | A list of the packages that contain initscripts. | 1349 | A list of the packages that contain initscripts. |
1350 | If multiple packages are specified, you need to append the package name | 1350 | If multiple packages are specified, you need to append the package name |
1351 | to the other <filename>INITSCRIPT_*</filename> as an override.</para> | 1351 | to the other <filename>INITSCRIPT_*</filename> as an override.</para> |
1352 | <para> | 1352 | <para> |
1353 | This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. | 1353 | This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. |
@@ -1372,12 +1372,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1372 | <glossdef> | 1372 | <glossdef> |
1373 | <para> | 1373 | <para> |
1374 | Specifies the options to pass to <filename>update-rc.d</filename>. | 1374 | Specifies the options to pass to <filename>update-rc.d</filename>. |
1375 | An example is <filename>start 99 5 2 . stop 20 0 1 6 .</filename>, which gives the script a | 1375 | An example is <filename>start 99 5 2 . stop 20 0 1 6 .</filename>, which gives the script a |
1376 | runlevel of 99, starts the script in initlevels 2 and 5, and | 1376 | runlevel of 99, starts the script in initlevels 2 and 5, and |
1377 | stops the script in levels 0, 1 and 6. | 1377 | stops the script in levels 0, 1 and 6. |
1378 | </para> | 1378 | </para> |
1379 | <para> | 1379 | <para> |
1380 | The variable is mandatory and is used in recipes when using | 1380 | The variable is mandatory and is used in recipes when using |
1381 | <filename>update-rc.d.bbclass</filename>. | 1381 | <filename>update-rc.d.bbclass</filename>. |
1382 | </para> | 1382 | </para> |
1383 | </glossdef> | 1383 | </glossdef> |
@@ -1394,36 +1394,36 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1394 | <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm> | 1394 | <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm> |
1395 | <glossdef> | 1395 | <glossdef> |
1396 | <para> | 1396 | <para> |
1397 | A regular expression used by the build process to explicitly identify the kernel | 1397 | A regular expression used by the build process to explicitly identify the kernel |
1398 | branch that is validated, patched and configured during a build. | 1398 | branch that is validated, patched and configured during a build. |
1399 | The <filename>KBRANCH</filename> variable is optional. | 1399 | The <filename>KBRANCH</filename> variable is optional. |
1400 | You can use it to trigger checks to ensure the exact kernel branch you want is | 1400 | You can use it to trigger checks to ensure the exact kernel branch you want is |
1401 | being used by the build process. | 1401 | being used by the build process. |
1402 | </para> | 1402 | </para> |
1403 | 1403 | ||
1404 | <para> | 1404 | <para> |
1405 | Values for this variable are set in the kernel's recipe file and the kernel's | 1405 | Values for this variable are set in the kernel's recipe file and the kernel's |
1406 | append file. | 1406 | append file. |
1407 | For example, if you are using the Yocto Project kernel that is based on the | 1407 | For example, if you are using the Yocto Project kernel that is based on the |
1408 | Linux 3.4 kernel, the kernel recipe file is the | 1408 | Linux 3.4 kernel, the kernel recipe file is the |
1409 | <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> file. | 1409 | <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> file. |
1410 | Following is the default value for <filename>KBRANCH</filename> and the default | 1410 | Following is the default value for <filename>KBRANCH</filename> and the default |
1411 | override for the architectures the Yocto Project supports: | 1411 | override for the architectures the Yocto Project supports: |
1412 | <literallayout class='monospaced'> | 1412 | <literallayout class='monospaced'> |
1413 | KBRANCH_DEFAULT = "standard/base" | 1413 | KBRANCH_DEFAULT = "standard/base" |
1414 | KBRANCH = "${KBRANCH_DEFAULT}" | 1414 | KBRANCH = "${KBRANCH_DEFAULT}" |
1415 | </literallayout> | 1415 | </literallayout> |
1416 | This branch exists in the <filename>linux-yocto-3.4</filename> kernel Git | 1416 | This branch exists in the <filename>linux-yocto-3.4</filename> kernel Git |
1417 | repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.4/refs/heads'></ulink>. | 1417 | repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.4/refs/heads'></ulink>. |
1418 | </para> | 1418 | </para> |
1419 | 1419 | ||
1420 | <para> | 1420 | <para> |
1421 | This variable is also used from the kernel's append file to identify the kernel | 1421 | This variable is also used from the kernel's append file to identify the kernel |
1422 | branch specific to a particular machine or target hardware. | 1422 | branch specific to a particular machine or target hardware. |
1423 | The kernel's append file is located in the BSP layer for a given machine. | 1423 | The kernel's append file is located in the BSP layer for a given machine. |
1424 | For example, the kernel append file for the Crown Bay BSP is in the | 1424 | For example, the kernel append file for the Crown Bay BSP is in the |
1425 | <filename>meta-intel</filename> Git repository and is named | 1425 | <filename>meta-intel</filename> Git repository and is named |
1426 | <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend</filename>. | 1426 | <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend</filename>. |
1427 | Here are the related statements from the append file: | 1427 | Here are the related statements from the append file: |
1428 | <literallayout class='monospaced'> | 1428 | <literallayout class='monospaced'> |
1429 | COMPATIBLE_MACHINE_crownbay = "crownbay" | 1429 | COMPATIBLE_MACHINE_crownbay = "crownbay" |
@@ -1434,9 +1434,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1434 | KMACHINE_crownbay-noemgd = "crownbay" | 1434 | KMACHINE_crownbay-noemgd = "crownbay" |
1435 | KBRANCH_crownbay-noemgd = "standard/crownbay" | 1435 | KBRANCH_crownbay-noemgd = "standard/crownbay" |
1436 | </literallayout> | 1436 | </literallayout> |
1437 | The <filename>KBRANCH_*</filename> statements identify the kernel branch to | 1437 | The <filename>KBRANCH_*</filename> statements identify the kernel branch to |
1438 | use when building for the Crown Bay BSP. | 1438 | use when building for the Crown Bay BSP. |
1439 | In this case there are two identical statements: one for each type of | 1439 | In this case there are two identical statements: one for each type of |
1440 | Crown Bay machine. | 1440 | Crown Bay machine. |
1441 | </para> | 1441 | </para> |
1442 | </glossdef> | 1442 | </glossdef> |
@@ -1446,18 +1446,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1446 | <glossdef> | 1446 | <glossdef> |
1447 | <para>Includes additional metadata from the Yocto Project kernel Git repository. | 1447 | <para>Includes additional metadata from the Yocto Project kernel Git repository. |
1448 | In the OpenEmbedded build system, the default Board Support Packages (BSPs) | 1448 | In the OpenEmbedded build system, the default Board Support Packages (BSPs) |
1449 | metadata is provided through | 1449 | metadata is provided through |
1450 | the <filename>KMACHINE</filename> and <filename>KBRANCH</filename> variables. | 1450 | the <filename>KMACHINE</filename> and <filename>KBRANCH</filename> variables. |
1451 | You can use the <filename>KERNEL_FEATURES</filename> variable to further | 1451 | You can use the <filename>KERNEL_FEATURES</filename> variable to further |
1452 | add metadata for all BSPs.</para> | 1452 | add metadata for all BSPs.</para> |
1453 | <para>The metadata you add through this variable includes config fragments and | 1453 | <para>The metadata you add through this variable includes config fragments and |
1454 | features descriptions, | 1454 | features descriptions, |
1455 | which usually includes patches as well as config fragments. | 1455 | which usually includes patches as well as config fragments. |
1456 | You typically override the <filename>KERNEL_FEATURES</filename> variable | 1456 | You typically override the <filename>KERNEL_FEATURES</filename> variable |
1457 | for a specific machine. | 1457 | for a specific machine. |
1458 | In this way, you can provide validated, but optional, sets of kernel | 1458 | In this way, you can provide validated, but optional, sets of kernel |
1459 | configurations and features.</para> | 1459 | configurations and features.</para> |
1460 | <para>For example, the following adds <filename>netfilter</filename> to all | 1460 | <para>For example, the following adds <filename>netfilter</filename> to all |
1461 | the Yocto Project kernels and adds sound support to the <filename>qemux86</filename> | 1461 | the Yocto Project kernels and adds sound support to the <filename>qemux86</filename> |
1462 | machine: | 1462 | machine: |
1463 | <literallayout class='monospaced'> | 1463 | <literallayout class='monospaced'> |
@@ -1472,10 +1472,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1472 | 1472 | ||
1473 | <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> | 1473 | <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> |
1474 | <glossdef> | 1474 | <glossdef> |
1475 | <para>The type of kernel to build for a device, usually set by the | 1475 | <para>The type of kernel to build for a device, usually set by the |
1476 | machine configuration files and defaults to "zImage". | 1476 | machine configuration files and defaults to "zImage". |
1477 | This variable is used | 1477 | This variable is used |
1478 | when building the kernel and is passed to <filename>make</filename> as the target to | 1478 | when building the kernel and is passed to <filename>make</filename> as the target to |
1479 | build.</para> | 1479 | build.</para> |
1480 | </glossdef> | 1480 | </glossdef> |
1481 | </glossentry> | 1481 | </glossentry> |
@@ -1486,22 +1486,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1486 | The machine as known by the kernel. | 1486 | The machine as known by the kernel. |
1487 | Sometimes the machine name used by the kernel does not match the machine name | 1487 | Sometimes the machine name used by the kernel does not match the machine name |
1488 | used by the OpenEmbedded build system. | 1488 | used by the OpenEmbedded build system. |
1489 | For example, the machine name that the OpenEmbedded build system understands as | 1489 | For example, the machine name that the OpenEmbedded build system understands as |
1490 | <filename>qemuarm</filename> goes by a different name in the Linux Yocto kernel. | 1490 | <filename>qemuarm</filename> goes by a different name in the Linux Yocto kernel. |
1491 | The kernel understands that machine as <filename>arm_versatile926ejs</filename>. | 1491 | The kernel understands that machine as <filename>arm_versatile926ejs</filename>. |
1492 | For cases like these, the <filename>KMACHINE</filename> variable maps the | 1492 | For cases like these, the <filename>KMACHINE</filename> variable maps the |
1493 | kernel machine name to the OpenEmbedded build system machine name. | 1493 | kernel machine name to the OpenEmbedded build system machine name. |
1494 | </para> | 1494 | </para> |
1495 | 1495 | ||
1496 | <para> | 1496 | <para> |
1497 | Kernel machine names are initially defined in the | 1497 | Kernel machine names are initially defined in the |
1498 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>Yocto Linux Kernel</ulink> in | 1498 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>Yocto Linux Kernel</ulink> in |
1499 | the <filename>meta</filename> branch. | 1499 | the <filename>meta</filename> branch. |
1500 | From the <filename>meta</filename> branch, look in | 1500 | From the <filename>meta</filename> branch, look in |
1501 | the <filename>meta/cfg/kernel-cache/bsp/<bsp_name>/<bsp-name>-<kernel-type>.scc</filename> file. | 1501 | the <filename>meta/cfg/kernel-cache/bsp/<bsp_name>/<bsp-name>-<kernel-type>.scc</filename> file. |
1502 | For example, from the <filename>meta</filename> branch in the | 1502 | For example, from the <filename>meta</filename> branch in the |
1503 | <filename>linux-yocto-3.0</filename> kernel, the | 1503 | <filename>linux-yocto-3.0</filename> kernel, the |
1504 | <filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file | 1504 | <filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file |
1505 | has the following: | 1505 | has the following: |
1506 | <literallayout class='monospaced'> | 1506 | <literallayout class='monospaced'> |
1507 | define KMACHINE cedartrail | 1507 | define KMACHINE cedartrail |
@@ -1511,7 +1511,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1511 | include ktypes/standard | 1511 | include ktypes/standard |
1512 | branch cedartrail | 1512 | branch cedartrail |
1513 | 1513 | ||
1514 | include cedartrail.scc | 1514 | include cedartrail.scc |
1515 | </literallayout> | 1515 | </literallayout> |
1516 | You can see that the kernel understands the machine name for the Cedar Trail BSP as | 1516 | You can see that the kernel understands the machine name for the Cedar Trail BSP as |
1517 | <filename>cedartrail</filename>. | 1517 | <filename>cedartrail</filename>. |
@@ -1533,14 +1533,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1533 | KBRANCH_cedartrail-nopvr = "yocto/standard/cedartrail" | 1533 | KBRANCH_cedartrail-nopvr = "yocto/standard/cedartrail" |
1534 | KERNEL_FEATURES_append_cedartrail-nopvr += " cfg/smp.scc" | 1534 | KERNEL_FEATURES_append_cedartrail-nopvr += " cfg/smp.scc" |
1535 | </literallayout> | 1535 | </literallayout> |
1536 | The <filename>KMACHINE</filename> statements in the kernel's append file make sure that | 1536 | The <filename>KMACHINE</filename> statements in the kernel's append file make sure that |
1537 | the OpenEmbedded build system and the Yocto Linux kernel understand the same machine | 1537 | the OpenEmbedded build system and the Yocto Linux kernel understand the same machine |
1538 | names. | 1538 | names. |
1539 | </para> | 1539 | </para> |
1540 | 1540 | ||
1541 | <para> | 1541 | <para> |
1542 | This append file uses two <filename>KMACHINE</filename> statements. | 1542 | This append file uses two <filename>KMACHINE</filename> statements. |
1543 | The first is not really necessary but does ensure that the machine known to the | 1543 | The first is not really necessary but does ensure that the machine known to the |
1544 | OpenEmbedded build system as <filename>cedartrail</filename> maps to the machine | 1544 | OpenEmbedded build system as <filename>cedartrail</filename> maps to the machine |
1545 | in the kernel also known as <filename>cedartrail</filename>: | 1545 | in the kernel also known as <filename>cedartrail</filename>: |
1546 | <literallayout class='monospaced'> | 1546 | <literallayout class='monospaced'> |
@@ -1550,12 +1550,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1550 | 1550 | ||
1551 | <para> | 1551 | <para> |
1552 | The second statement is a good example of why the <filename>KMACHINE</filename> variable | 1552 | The second statement is a good example of why the <filename>KMACHINE</filename> variable |
1553 | is needed. | 1553 | is needed. |
1554 | In this example, the OpenEmbedded build system uses the <filename>cedartrail-nopvr</filename> | 1554 | In this example, the OpenEmbedded build system uses the <filename>cedartrail-nopvr</filename> |
1555 | machine name to refer to the Cedar Trail BSP that does not support the propriatory | 1555 | machine name to refer to the Cedar Trail BSP that does not support the propriatory |
1556 | PowerVR driver. | 1556 | PowerVR driver. |
1557 | The kernel, however, uses the machine name <filename>cedartrail</filename>. | 1557 | The kernel, however, uses the machine name <filename>cedartrail</filename>. |
1558 | Thus, the append file must map the <filename>cedartrail-nopvr</filename> machine name to | 1558 | Thus, the append file must map the <filename>cedartrail-nopvr</filename> machine name to |
1559 | the kernel's <filename>cedartrail</filename> name: | 1559 | the kernel's <filename>cedartrail</filename> name: |
1560 | <literallayout class='monospaced'> | 1560 | <literallayout class='monospaced'> |
1561 | KMACHINE_cedartrail-nopvr = "cedartrail" | 1561 | KMACHINE_cedartrail-nopvr = "cedartrail" |
@@ -1563,9 +1563,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1563 | </para> | 1563 | </para> |
1564 | 1564 | ||
1565 | <para> | 1565 | <para> |
1566 | BSPs that ship with the Yocto Project release provide all mappings between the Yocto | 1566 | BSPs that ship with the Yocto Project release provide all mappings between the Yocto |
1567 | Project kernel machine names and the OpenEmbedded machine names. | 1567 | Project kernel machine names and the OpenEmbedded machine names. |
1568 | Be sure to use the <filename>KMACHINE</filename> if you create a BSP and the machine | 1568 | Be sure to use the <filename>KMACHINE</filename> if you create a BSP and the machine |
1569 | name you use is different than that used in the kernel. | 1569 | name you use is different than that used in the kernel. |
1570 | </para> | 1570 | </para> |
1571 | </glossdef> | 1571 | </glossdef> |
@@ -1583,16 +1583,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1583 | to be compared against <filename>LAYERVERSION_anotherlayer</filename> in this case). | 1583 | to be compared against <filename>LAYERVERSION_anotherlayer</filename> in this case). |
1584 | An error will be produced if any dependency is missing or | 1584 | An error will be produced if any dependency is missing or |
1585 | the version numbers do not match exactly (if specified). | 1585 | the version numbers do not match exactly (if specified). |
1586 | This variable is used in the <filename>conf/layer.conf</filename> file | 1586 | This variable is used in the <filename>conf/layer.conf</filename> file |
1587 | and must be suffixed with the name of the specific layer (e.g. | 1587 | and must be suffixed with the name of the specific layer (e.g. |
1588 | <filename>LAYERDEPENDS_mylayer</filename>).</para> | 1588 | <filename>LAYERDEPENDS_mylayer</filename>).</para> |
1589 | </glossdef> | 1589 | </glossdef> |
1590 | </glossentry> | 1590 | </glossentry> |
1591 | 1591 | ||
1592 | <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm> | 1592 | <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm> |
1593 | <glossdef> | 1593 | <glossdef> |
1594 | <para>When used inside the <filename>layer.conf</filename> configuration | 1594 | <para>When used inside the <filename>layer.conf</filename> configuration |
1595 | file, this variable provides the path of the current layer. | 1595 | file, this variable provides the path of the current layer. |
1596 | This variable requires immediate expansion | 1596 | This variable requires immediate expansion |
1597 | (see the BitBake manual) as lazy expansion can result in | 1597 | (see the BitBake manual) as lazy expansion can result in |
1598 | the expansion happening in the wrong directory and therefore | 1598 | the expansion happening in the wrong directory and therefore |
@@ -1605,7 +1605,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1605 | <para>Optionally specifies the version of a layer as a single number. | 1605 | <para>Optionally specifies the version of a layer as a single number. |
1606 | You can use this within <filename>LAYERDEPENDS</filename> for another layer in order to | 1606 | You can use this within <filename>LAYERDEPENDS</filename> for another layer in order to |
1607 | depend on a specific version of the layer. | 1607 | depend on a specific version of the layer. |
1608 | This variable is used in the <filename>conf/layer.conf</filename> file | 1608 | This variable is used in the <filename>conf/layer.conf</filename> file |
1609 | and must be suffixed with the name of the specific layer (e.g. | 1609 | and must be suffixed with the name of the specific layer (e.g. |
1610 | <filename>LAYERVERSION_mylayer</filename>).</para> | 1610 | <filename>LAYERVERSION_mylayer</filename>).</para> |
1611 | </glossdef> | 1611 | </glossdef> |
@@ -1615,9 +1615,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1615 | <glossdef> | 1615 | <glossdef> |
1616 | <para>Checksums of the license text in the recipe source code.</para> | 1616 | <para>Checksums of the license text in the recipe source code.</para> |
1617 | <para>This variable tracks changes in license text of the source | 1617 | <para>This variable tracks changes in license text of the source |
1618 | code files. | 1618 | code files. |
1619 | If the license text is changed, it will trigger a build | 1619 | If the license text is changed, it will trigger a build |
1620 | failure, which gives the developer an opportunity to review any | 1620 | failure, which gives the developer an opportunity to review any |
1621 | license change.</para> | 1621 | license change.</para> |
1622 | <para> | 1622 | <para> |
1623 | This variable must be defined for all recipes (unless <filename>LICENSE</filename> | 1623 | This variable must be defined for all recipes (unless <filename>LICENSE</filename> |
@@ -1636,14 +1636,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1636 | <itemizedlist> | 1636 | <itemizedlist> |
1637 | <listitem><para>Do not use spaces within individual | 1637 | <listitem><para>Do not use spaces within individual |
1638 | license names.</para></listitem> | 1638 | license names.</para></listitem> |
1639 | <listitem><para>Separate license names using | 1639 | <listitem><para>Separate license names using |
1640 | | (pipe) when there is a choice between licenses. | 1640 | | (pipe) when there is a choice between licenses. |
1641 | </para></listitem> | 1641 | </para></listitem> |
1642 | <listitem><para>Separate license names using | 1642 | <listitem><para>Separate license names using |
1643 | & (ampersand) when multiple licenses exist | 1643 | & (ampersand) when multiple licenses exist |
1644 | that cover different parts of the source. | 1644 | that cover different parts of the source. |
1645 | </para></listitem> | 1645 | </para></listitem> |
1646 | <listitem><para>You can use spaces between license | 1646 | <listitem><para>You can use spaces between license |
1647 | names.</para></listitem> | 1647 | names.</para></listitem> |
1648 | </itemizedlist> | 1648 | </itemizedlist> |
1649 | </para> | 1649 | </para> |
@@ -1655,12 +1655,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1655 | LICENSE = "MPL-1 & LGPLv2.1" | 1655 | LICENSE = "MPL-1 & LGPLv2.1" |
1656 | LICENSE = "GPLv2+" | 1656 | LICENSE = "GPLv2+" |
1657 | </literallayout> | 1657 | </literallayout> |
1658 | The first example is from the recipes for Qt, which the user | 1658 | The first example is from the recipes for Qt, which the user |
1659 | may choose to distribute under either the LGPL version | 1659 | may choose to distribute under either the LGPL version |
1660 | 2.1 or GPL version 3. | 1660 | 2.1 or GPL version 3. |
1661 | The second example is from Cairo where two licenses cover | 1661 | The second example is from Cairo where two licenses cover |
1662 | different parts of the source code. | 1662 | different parts of the source code. |
1663 | The final example is from <filename>sysstat</filename>, | 1663 | The final example is from <filename>sysstat</filename>, |
1664 | which presents a single license. | 1664 | which presents a single license. |
1665 | </para> | 1665 | </para> |
1666 | </glossdef> | 1666 | </glossdef> |
@@ -1669,10 +1669,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1669 | <glossentry id='var-LICENSE_PATH'><glossterm>LICENSE_PATH</glossterm> | 1669 | <glossentry id='var-LICENSE_PATH'><glossterm>LICENSE_PATH</glossterm> |
1670 | <glossdef> | 1670 | <glossdef> |
1671 | <para>Path to additional licenses used during the build. | 1671 | <para>Path to additional licenses used during the build. |
1672 | By default, the OpenEmbedded build system uses <filename>COMMON_LICENSE_DIR</filename> | 1672 | By default, the OpenEmbedded build system uses <filename>COMMON_LICENSE_DIR</filename> |
1673 | to define the directory that holds common license text used during the build. | 1673 | to define the directory that holds common license text used during the build. |
1674 | The <filename>LICENSE_PATH</filename> variable allows you to extend that | 1674 | The <filename>LICENSE_PATH</filename> variable allows you to extend that |
1675 | location to other areas that have additional licenses: | 1675 | location to other areas that have additional licenses: |
1676 | <literallayout class='monospaced'> | 1676 | <literallayout class='monospaced'> |
1677 | LICENSE_PATH += "/path/to/additional/common/licenses" | 1677 | LICENSE_PATH += "/path/to/additional/common/licenses" |
1678 | </literallayout></para> | 1678 | </literallayout></para> |
@@ -1687,26 +1687,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1687 | <glossdef> | 1687 | <glossdef> |
1688 | <para> | 1688 | <para> |
1689 | Specifies the target device for which the image is built. | 1689 | Specifies the target device for which the image is built. |
1690 | You define <filename>MACHINE</filename> in the | 1690 | You define <filename>MACHINE</filename> in the |
1691 | <filename>local.conf</filename> file found in the | 1691 | <filename>local.conf</filename> file found in the |
1692 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 1692 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
1693 | By default, <filename>MACHINE</filename> is set to | 1693 | By default, <filename>MACHINE</filename> is set to |
1694 | "qemux86", which is an x86-based architecture machine to | 1694 | "qemux86", which is an x86-based architecture machine to |
1695 | be emulated using QEMU: | 1695 | be emulated using QEMU: |
1696 | <literallayout class='monospaced'> | 1696 | <literallayout class='monospaced'> |
1697 | MACHINE ?= "qemux86" | 1697 | MACHINE ?= "qemux86" |
1698 | </literallayout> | 1698 | </literallayout> |
1699 | The variable corresponds to a machine configuration file of the | 1699 | The variable corresponds to a machine configuration file of the |
1700 | same name, through which machine-specific configurations are set. | 1700 | same name, through which machine-specific configurations are set. |
1701 | Thus, when <filename>MACHINE</filename> is set to "qemux86" there | 1701 | Thus, when <filename>MACHINE</filename> is set to "qemux86" there |
1702 | exists the corresponding <filename>qemux86.conf</filename> machine | 1702 | exists the corresponding <filename>qemux86.conf</filename> machine |
1703 | configuration file, which can be found in the | 1703 | configuration file, which can be found in the |
1704 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 1704 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> |
1705 | in <filename>meta/conf/machine</filename>. | 1705 | in <filename>meta/conf/machine</filename>. |
1706 | </para> | 1706 | </para> |
1707 | 1707 | ||
1708 | <para> | 1708 | <para> |
1709 | The list of machines supported by the Yocto Project as | 1709 | The list of machines supported by the Yocto Project as |
1710 | shipped include the following: | 1710 | shipped include the following: |
1711 | <literallayout class='monospaced'> | 1711 | <literallayout class='monospaced'> |
1712 | MACHINE ?= "qemuarm" | 1712 | MACHINE ?= "qemuarm" |
@@ -1721,10 +1721,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1721 | </literallayout> | 1721 | </literallayout> |
1722 | The last four are Yocto Project reference hardware boards, which | 1722 | The last four are Yocto Project reference hardware boards, which |
1723 | are provided in the <filename>meta-yocto-bsp</filename> layer. | 1723 | are provided in the <filename>meta-yocto-bsp</filename> layer. |
1724 | <note>Adding additional Board Support Package (BSP) layers | 1724 | <note>Adding additional Board Support Package (BSP) layers |
1725 | to your configuration adds new possible settings for | 1725 | to your configuration adds new possible settings for |
1726 | <filename>MACHINE</filename>. | 1726 | <filename>MACHINE</filename>. |
1727 | </note> | 1727 | </note> |
1728 | </para> | 1728 | </para> |
1729 | </glossdef> | 1729 | </glossdef> |
1730 | </glossentry> | 1730 | </glossentry> |
@@ -1736,16 +1736,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1736 | A list of required machine-specific packages to install as part of | 1736 | A list of required machine-specific packages to install as part of |
1737 | the image being built. | 1737 | the image being built. |
1738 | The build process depends on these packages being present. | 1738 | The build process depends on these packages being present. |
1739 | Furthermore, because this is a "machine essential" variable, the list of | 1739 | Furthermore, because this is a "machine essential" variable, the list of |
1740 | packages are essential for the machine to boot. | 1740 | packages are essential for the machine to boot. |
1741 | The impact of this variable affects images based on | 1741 | The impact of this variable affects images based on |
1742 | <filename>packagegroup-core-boot</filename>, | 1742 | <filename>packagegroup-core-boot</filename>, |
1743 | including the <filename>core-image-minimal</filename> image. | 1743 | including the <filename>core-image-minimal</filename> image. |
1744 | </para> | 1744 | </para> |
1745 | <para> | 1745 | <para> |
1746 | This variable is similar to the | 1746 | This variable is similar to the |
1747 | <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename> | 1747 | <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename> |
1748 | variable with the exception that the image being built has a build | 1748 | variable with the exception that the image being built has a build |
1749 | dependency on the variable's list of packages. | 1749 | dependency on the variable's list of packages. |
1750 | In other words, the image will not build if a file in this list is not found. | 1750 | In other words, the image will not build if a file in this list is not found. |
1751 | </para> | 1751 | </para> |
@@ -1768,16 +1768,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1768 | A list of recommended machine-specific packages to install as part of | 1768 | A list of recommended machine-specific packages to install as part of |
1769 | the image being built. | 1769 | the image being built. |
1770 | The build process does not depend on these packages being present. | 1770 | The build process does not depend on these packages being present. |
1771 | However, because this is a "machine essential" variable, the list of | 1771 | However, because this is a "machine essential" variable, the list of |
1772 | packages are essential for the machine to boot. | 1772 | packages are essential for the machine to boot. |
1773 | The impact of this variable affects images based on | 1773 | The impact of this variable affects images based on |
1774 | <filename>packagegroup-core-boot</filename>, | 1774 | <filename>packagegroup-core-boot</filename>, |
1775 | including the <filename>core-image-minimal</filename> image. | 1775 | including the <filename>core-image-minimal</filename> image. |
1776 | </para> | 1776 | </para> |
1777 | <para> | 1777 | <para> |
1778 | This variable is similar to the | 1778 | This variable is similar to the |
1779 | <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename> | 1779 | <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename> |
1780 | variable with the exception that the image being built does not have a build | 1780 | variable with the exception that the image being built does not have a build |
1781 | dependency on the variable's list of packages. | 1781 | dependency on the variable's list of packages. |
1782 | In other words, the image will still build if a package in this list is not found. | 1782 | In other words, the image will still build if a package in this list is not found. |
1783 | Typically, this variable is used to handle essential kernel modules, whose | 1783 | Typically, this variable is used to handle essential kernel modules, whose |
@@ -1790,20 +1790,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1790 | However, the driver can be built as a module or | 1790 | However, the driver can be built as a module or |
1791 | into the kernel depending on the kernel configuration. | 1791 | into the kernel depending on the kernel configuration. |
1792 | If the driver is built as a module, you want it to be installed. | 1792 | If the driver is built as a module, you want it to be installed. |
1793 | But, when the driver is built into the kernel, you still want the | 1793 | But, when the driver is built into the kernel, you still want the |
1794 | build to succeed. | 1794 | build to succeed. |
1795 | This variable sets up a "recommends" relationship so that in the latter case, | 1795 | This variable sets up a "recommends" relationship so that in the latter case, |
1796 | the build will not fail due to the missing package. | 1796 | the build will not fail due to the missing package. |
1797 | To accomplish this, assuming the package for the module was called | 1797 | To accomplish this, assuming the package for the module was called |
1798 | <filename>kernel-module-ab123</filename>, you would use the | 1798 | <filename>kernel-module-ab123</filename>, you would use the |
1799 | following in the machine's <filename>.conf</filename> configuration | 1799 | following in the machine's <filename>.conf</filename> configuration |
1800 | file: | 1800 | file: |
1801 | <literallayout class='monospaced'> | 1801 | <literallayout class='monospaced'> |
1802 | MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123" | 1802 | MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123" |
1803 | </literallayout> | 1803 | </literallayout> |
1804 | </para> | 1804 | </para> |
1805 | <para> | 1805 | <para> |
1806 | Some examples of these machine essentials are flash, screen, keyboard, mouse, | 1806 | Some examples of these machine essentials are flash, screen, keyboard, mouse, |
1807 | or touchscreen drivers (depending on the machine). | 1807 | or touchscreen drivers (depending on the machine). |
1808 | </para> | 1808 | </para> |
1809 | </glossdef> | 1809 | </glossdef> |
@@ -1812,21 +1812,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1812 | <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm> | 1812 | <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm> |
1813 | <glossdef> | 1813 | <glossdef> |
1814 | <para> | 1814 | <para> |
1815 | A list of machine-specific packages to install as part of the | 1815 | A list of machine-specific packages to install as part of the |
1816 | image being built that are not essential for the machine to boot. | 1816 | image being built that are not essential for the machine to boot. |
1817 | However, the build process for more fully-featured images | 1817 | However, the build process for more fully-featured images |
1818 | depends on the packages being present. | 1818 | depends on the packages being present. |
1819 | </para> | 1819 | </para> |
1820 | <para> | 1820 | <para> |
1821 | This variable affects all images based on | 1821 | This variable affects all images based on |
1822 | <filename>packagegroup-base</filename>, which does not include the | 1822 | <filename>packagegroup-base</filename>, which does not include the |
1823 | <filename>core-image-minimal</filename> or <filename>core-image-basic</filename> | 1823 | <filename>core-image-minimal</filename> or <filename>core-image-basic</filename> |
1824 | images. | 1824 | images. |
1825 | </para> | 1825 | </para> |
1826 | <para> | 1826 | <para> |
1827 | The variable is similar to the | 1827 | The variable is similar to the |
1828 | <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename> | 1828 | <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename> |
1829 | variable with the exception that the image being built has a build | 1829 | variable with the exception that the image being built has a build |
1830 | dependency on the variable's list of packages. | 1830 | dependency on the variable's list of packages. |
1831 | In other words, the image will not build if a file in this list is not found. | 1831 | In other words, the image will not build if a file in this list is not found. |
1832 | </para> | 1832 | </para> |
@@ -1834,8 +1834,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1834 | An example is a machine that has WiFi capability but is not essential | 1834 | An example is a machine that has WiFi capability but is not essential |
1835 | For the machine to boot the image. | 1835 | For the machine to boot the image. |
1836 | However, if you are building a more fully-featured image, you want to enable | 1836 | However, if you are building a more fully-featured image, you want to enable |
1837 | the WiFi. | 1837 | the WiFi. |
1838 | The package containing the firmware for the WiFi hardware is always | 1838 | The package containing the firmware for the WiFi hardware is always |
1839 | expected to exist, so it is acceptable for the build process to depend upon | 1839 | expected to exist, so it is acceptable for the build process to depend upon |
1840 | finding the package. | 1840 | finding the package. |
1841 | In this case, assuming the package for the firmware was called | 1841 | In this case, assuming the package for the firmware was called |
@@ -1852,20 +1852,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1852 | <glossdef> | 1852 | <glossdef> |
1853 | <para></para> | 1853 | <para></para> |
1854 | <para> | 1854 | <para> |
1855 | A list of machine-specific packages to install as part of the | 1855 | A list of machine-specific packages to install as part of the |
1856 | image being built that are not essential for booting the machine. | 1856 | image being built that are not essential for booting the machine. |
1857 | The image being built has no build dependency on this list of packages. | 1857 | The image being built has no build dependency on this list of packages. |
1858 | </para> | 1858 | </para> |
1859 | <para> | 1859 | <para> |
1860 | This variable affects only images based on | 1860 | This variable affects only images based on |
1861 | <filename>packagegroup-base</filename>, which does not include the | 1861 | <filename>packagegroup-base</filename>, which does not include the |
1862 | <filename>core-image-minimal</filename> or <filename>core-image-basic</filename> | 1862 | <filename>core-image-minimal</filename> or <filename>core-image-basic</filename> |
1863 | images. | 1863 | images. |
1864 | </para> | 1864 | </para> |
1865 | <para> | 1865 | <para> |
1866 | This variable is similar to the | 1866 | This variable is similar to the |
1867 | <filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename> | 1867 | <filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename> |
1868 | variable with the exception that the image being built does not have a build | 1868 | variable with the exception that the image being built does not have a build |
1869 | dependency on the variable's list of packages. | 1869 | dependency on the variable's list of packages. |
1870 | In other words, the image will build if a file in this list is not found. | 1870 | In other words, the image will build if a file in this list is not found. |
1871 | </para> | 1871 | </para> |
@@ -1873,7 +1873,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1873 | An example is a machine that has WiFi capability but is not essential | 1873 | An example is a machine that has WiFi capability but is not essential |
1874 | For the machine to boot the image. | 1874 | For the machine to boot the image. |
1875 | However, if you are building a more fully-featured image, you want to enable | 1875 | However, if you are building a more fully-featured image, you want to enable |
1876 | WiFi. | 1876 | WiFi. |
1877 | In this case, the package containing the WiFi kernel module will not be produced | 1877 | In this case, the package containing the WiFi kernel module will not be produced |
1878 | if the WiFi driver is built into the kernel, in which case you still want the | 1878 | if the WiFi driver is built into the kernel, in which case you still want the |
1879 | build to succeed instead of failing as a result of the package not being found. | 1879 | build to succeed instead of failing as a result of the package not being found. |
@@ -1889,19 +1889,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1889 | 1889 | ||
1890 | <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> | 1890 | <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> |
1891 | <glossdef> | 1891 | <glossdef> |
1892 | <para>Specifies the list of hardware features the | 1892 | <para>Specifies the list of hardware features the |
1893 | <link linkend='var-MACHINE'>MACHINE</link> supports. | 1893 | <link linkend='var-MACHINE'>MACHINE</link> supports. |
1894 | For example, including the "bluetooth" feature causes the | 1894 | For example, including the "bluetooth" feature causes the |
1895 | <filename>bluez</filename> bluetooth daemon to be built and | 1895 | <filename>bluez</filename> bluetooth daemon to be built and |
1896 | added to the image. | 1896 | added to the image. |
1897 | It also causes the <filename>connman</filename> recipe | 1897 | It also causes the <filename>connman</filename> recipe |
1898 | to look at <filename>MACHINE_FEATURES</filename> and when it | 1898 | to look at <filename>MACHINE_FEATURES</filename> and when it |
1899 | finds "bluetooth" there it enables the bluetooth | 1899 | finds "bluetooth" there it enables the bluetooth |
1900 | support in ConnMan. | 1900 | support in ConnMan. |
1901 | </para> | 1901 | </para> |
1902 | 1902 | ||
1903 | <para> | 1903 | <para> |
1904 | For a list of features supported by the Yocto Project as shipped, | 1904 | For a list of features supported by the Yocto Project as shipped, |
1905 | see the "<link linkend='ref-features-machine'>Machine</link>" section. | 1905 | see the "<link linkend='ref-features-machine'>Machine</link>" section. |
1906 | </para> | 1906 | </para> |
1907 | </glossdef> | 1907 | </glossdef> |
@@ -1909,18 +1909,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1909 | 1909 | ||
1910 | <glossentry id='var-MACHINE_FEATURES_BACKFILL'><glossterm>MACHINE_FEATURES_BACKFILL</glossterm> | 1910 | <glossentry id='var-MACHINE_FEATURES_BACKFILL'><glossterm>MACHINE_FEATURES_BACKFILL</glossterm> |
1911 | <glossdef> | 1911 | <glossdef> |
1912 | <para>Features to be added to | 1912 | <para>Features to be added to |
1913 | <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename> | 1913 | <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename> |
1914 | if not also present in | 1914 | if not also present in |
1915 | <filename><link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'>MACHINE_FEATURES_BACKFILL_CONSIDERED</link></filename>. | 1915 | <filename><link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'>MACHINE_FEATURES_BACKFILL_CONSIDERED</link></filename>. |
1916 | </para> | 1916 | </para> |
1917 | 1917 | ||
1918 | <para> | 1918 | <para> |
1919 | This variable is set in the <filename>meta/conf/bitbake.conf</filename> file. | 1919 | This variable is set in the <filename>meta/conf/bitbake.conf</filename> file. |
1920 | It is not intended to be user-configurable. | 1920 | It is not intended to be user-configurable. |
1921 | It is best to just reference the variable to see which machine features are | 1921 | It is best to just reference the variable to see which machine features are |
1922 | being backfilled for all machine configurations. | 1922 | being backfilled for all machine configurations. |
1923 | See the <link linkend='ref-features-backfill'>Feature backfilling</link> section for | 1923 | See the <link linkend='ref-features-backfill'>Feature backfilling</link> section for |
1924 | more information. | 1924 | more information. |
1925 | </para> | 1925 | </para> |
1926 | </glossdef> | 1926 | </glossdef> |
@@ -1933,7 +1933,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1933 | that should not be backfilled (i.e. added to | 1933 | that should not be backfilled (i.e. added to |
1934 | <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>) | 1934 | <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>) |
1935 | during the build. | 1935 | during the build. |
1936 | See the <link linkend='ref-features-backfill'>Feature backfilling</link> section for | 1936 | See the <link linkend='ref-features-backfill'>Feature backfilling</link> section for |
1937 | more information. | 1937 | more information. |
1938 | </para> | 1938 | </para> |
1939 | </glossdef> | 1939 | </glossdef> |
@@ -1949,13 +1949,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1949 | <glossdef> | 1949 | <glossdef> |
1950 | <para> | 1950 | <para> |
1951 | Specifies a prefix has been added to | 1951 | Specifies a prefix has been added to |
1952 | <link linkend='var-PN'><filename>PN</filename></link> to create a special version | 1952 | <link linkend='var-PN'><filename>PN</filename></link> to create a special version |
1953 | of a recipe or package, such as a multilib version. | 1953 | of a recipe or package, such as a multilib version. |
1954 | The variable is used in places where the prefix needs to be | 1954 | The variable is used in places where the prefix needs to be |
1955 | added to or removed from a the name (e.g. the | 1955 | added to or removed from a the name (e.g. the |
1956 | <link linkend='var-BPN'><filename>BPN</filename></link> variable). | 1956 | <link linkend='var-BPN'><filename>BPN</filename></link> variable). |
1957 | <filename>MLPREFIX</filename> gets set when a prefix has been | 1957 | <filename>MLPREFIX</filename> gets set when a prefix has been |
1958 | added to <filename>PN</filename>. | 1958 | added to <filename>PN</filename>. |
1959 | </para> | 1959 | </para> |
1960 | </glossdef> | 1960 | </glossdef> |
1961 | </glossentry> | 1961 | </glossentry> |
@@ -1981,17 +1981,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1981 | <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm> | 1981 | <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm> |
1982 | <glossdef> | 1982 | <glossdef> |
1983 | <para> | 1983 | <para> |
1984 | Controls how the OpenEmbedded build system spawns | 1984 | Controls how the OpenEmbedded build system spawns |
1985 | interactive terminals on the host development system | 1985 | interactive terminals on the host development system |
1986 | (e.g. using the BitBake command with the | 1986 | (e.g. using the BitBake command with the |
1987 | <filename>-c devshell</filename> command-line option). | 1987 | <filename>-c devshell</filename> command-line option). |
1988 | For more information, see the | 1988 | For more information, see the |
1989 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section | 1989 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section |
1990 | in the Yocto Project Development Manual. | 1990 | in the Yocto Project Development Manual. |
1991 | </para> | 1991 | </para> |
1992 | 1992 | ||
1993 | <para> | 1993 | <para> |
1994 | You can use the following values for the | 1994 | You can use the following values for the |
1995 | <filename>OE_TERMINAL</filename> variable: | 1995 | <filename>OE_TERMINAL</filename> variable: |
1996 | <literallayout class='monospaced'> | 1996 | <literallayout class='monospaced'> |
1997 | auto | 1997 | auto |
@@ -2000,10 +2000,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2000 | rxvt | 2000 | rxvt |
2001 | screen | 2001 | screen |
2002 | konsole | 2002 | konsole |
2003 | none | 2003 | none |
2004 | </literallayout> | 2004 | </literallayout> |
2005 | <note>Konsole support only works for KDE 3.x. | 2005 | <note>Konsole support only works for KDE 3.x. |
2006 | Also, "auto" is the default behavior for | 2006 | Also, "auto" is the default behavior for |
2007 | <filename>OE_TERMINAL</filename></note> | 2007 | <filename>OE_TERMINAL</filename></note> |
2008 | </para> | 2008 | </para> |
2009 | </glossdef> | 2009 | </glossdef> |
@@ -2030,9 +2030,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2030 | 2030 | ||
2031 | <glossentry id='var-PACKAGE_BEFORE_PN'><glossterm>PACKAGE_BEFORE_PN</glossterm> | 2031 | <glossentry id='var-PACKAGE_BEFORE_PN'><glossterm>PACKAGE_BEFORE_PN</glossterm> |
2032 | <glossdef> | 2032 | <glossdef> |
2033 | <para>Enables easily adding packages to | 2033 | <para>Enables easily adding packages to |
2034 | <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> | 2034 | <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> |
2035 | before <filename>${PN}</filename> so that the packages can pick | 2035 | before <filename>${PN}</filename> so that the packages can pick |
2036 | up files that would normally be included in the default package.</para> | 2036 | up files that would normally be included in the default package.</para> |
2037 | </glossdef> | 2037 | </glossdef> |
2038 | </glossentry> | 2038 | </glossentry> |
@@ -2040,15 +2040,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2040 | <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm> | 2040 | <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm> |
2041 | <glossdef> | 2041 | <glossdef> |
2042 | <para>This variable, which is set in the <filename>local.conf</filename> configuration | 2042 | <para>This variable, which is set in the <filename>local.conf</filename> configuration |
2043 | file found in the <filename>conf</filename> folder of the | 2043 | file found in the <filename>conf</filename> folder of the |
2044 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, | 2044 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, |
2045 | specifies the package manager to use when packaging data. | 2045 | specifies the package manager to use when packaging data. |
2046 | You can provide one or more arguments for the variable with the first | 2046 | You can provide one or more arguments for the variable with the first |
2047 | argument being the package manager used to create images: | 2047 | argument being the package manager used to create images: |
2048 | <literallayout class='monospaced'> | 2048 | <literallayout class='monospaced'> |
2049 | PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk" | 2049 | PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk" |
2050 | </literallayout> | 2050 | </literallayout> |
2051 | For information on build performance effects as a result of the | 2051 | For information on build performance effects as a result of the |
2052 | package manager use, see | 2052 | package manager use, see |
2053 | <link linkend='ref-classes-package'>Packaging - <filename>package*.bbclass</filename></link> | 2053 | <link linkend='ref-classes-package'>Packaging - <filename>package*.bbclass</filename></link> |
2054 | in this manual. | 2054 | in this manual. |
@@ -2067,33 +2067,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2067 | <glossentry id='var-PACKAGECONFIG'><glossterm>PACKAGECONFIG</glossterm> | 2067 | <glossentry id='var-PACKAGECONFIG'><glossterm>PACKAGECONFIG</glossterm> |
2068 | <glossdef> | 2068 | <glossdef> |
2069 | <para> | 2069 | <para> |
2070 | This variable provides a means of enabling or disabling | 2070 | This variable provides a means of enabling or disabling |
2071 | features of a recipe on a per-recipe basis. | 2071 | features of a recipe on a per-recipe basis. |
2072 | The <filename>PACKAGECONFIG</filename> | 2072 | The <filename>PACKAGECONFIG</filename> |
2073 | variable itself specifies a space-separated list of the | 2073 | variable itself specifies a space-separated list of the |
2074 | features to enable. | 2074 | features to enable. |
2075 | The features themselves are specified as flags on the | 2075 | The features themselves are specified as flags on the |
2076 | <filename>PACKAGECONFIG</filename> variable. | 2076 | <filename>PACKAGECONFIG</filename> variable. |
2077 | You can provide up to four arguments, which are separated by | 2077 | You can provide up to four arguments, which are separated by |
2078 | commas, to determine the behavior of each feature | 2078 | commas, to determine the behavior of each feature |
2079 | when it is enabled or disabled. | 2079 | when it is enabled or disabled. |
2080 | You can omit any argument you like but must retain the | 2080 | You can omit any argument you like but must retain the |
2081 | separating commas. | 2081 | separating commas. |
2082 | The arguments specify the following: | 2082 | The arguments specify the following: |
2083 | <orderedlist> | 2083 | <orderedlist> |
2084 | <listitem><para>Extra arguments | 2084 | <listitem><para>Extra arguments |
2085 | that should be added to the configure script argument list | 2085 | that should be added to the configure script argument list |
2086 | (<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>) | 2086 | (<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>) |
2087 | if the feature is enabled.</para></listitem> | 2087 | if the feature is enabled.</para></listitem> |
2088 | <listitem><para>Extra arguments | 2088 | <listitem><para>Extra arguments |
2089 | that should be added to <filename>EXTRA_OECONF</filename> | 2089 | that should be added to <filename>EXTRA_OECONF</filename> |
2090 | if the feature is disabled. | 2090 | if the feature is disabled. |
2091 | </para></listitem> | 2091 | </para></listitem> |
2092 | <listitem><para>Additional build dependencies | 2092 | <listitem><para>Additional build dependencies |
2093 | (<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>) | 2093 | (<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>) |
2094 | that should be added if the feature is enabled. | 2094 | that should be added if the feature is enabled. |
2095 | </para></listitem> | 2095 | </para></listitem> |
2096 | <listitem><para>Additional runtime dependencies | 2096 | <listitem><para>Additional runtime dependencies |
2097 | (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) | 2097 | (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) |
2098 | that should be added if the feature is enabled. | 2098 | that should be added if the feature is enabled. |
2099 | </para></listitem> | 2099 | </para></listitem> |
@@ -2101,25 +2101,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2101 | </para> | 2101 | </para> |
2102 | 2102 | ||
2103 | <para> | 2103 | <para> |
2104 | Consider the following example taken from the | 2104 | Consider the following example taken from the |
2105 | <filename>librsvg</filename> recipe. | 2105 | <filename>librsvg</filename> recipe. |
2106 | In this example the feature is <filename>croco</filename>, which | 2106 | In this example the feature is <filename>croco</filename>, which |
2107 | has three arguments that determine the feature's behavior. | 2107 | has three arguments that determine the feature's behavior. |
2108 | <literallayout class='monospaced'> | 2108 | <literallayout class='monospaced'> |
2109 | PACKAGECONFIG ??= "croco" | 2109 | PACKAGECONFIG ??= "croco" |
2110 | PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco" | 2110 | PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco" |
2111 | </literallayout> | 2111 | </literallayout> |
2112 | The <filename>--with-croco</filename> and | 2112 | The <filename>--with-croco</filename> and |
2113 | <filename>libcroco</filename> arguments apply only if | 2113 | <filename>libcroco</filename> arguments apply only if |
2114 | the feature is enabled. | 2114 | the feature is enabled. |
2115 | In this case, <filename>--with-croco</filename> is | 2115 | In this case, <filename>--with-croco</filename> is |
2116 | added to the configure script argument list and | 2116 | added to the configure script argument list and |
2117 | <filename>libcroco</filename> is added to | 2117 | <filename>libcroco</filename> is added to |
2118 | <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>. | 2118 | <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>. |
2119 | On the other hand, if the feature is disabled say through | 2119 | On the other hand, if the feature is disabled say through |
2120 | a <filename>.bbappend</filename> file in another layer, then | 2120 | a <filename>.bbappend</filename> file in another layer, then |
2121 | the second argument <filename>--without-croco</filename> is | 2121 | the second argument <filename>--without-croco</filename> is |
2122 | added to the configure script rather than | 2122 | added to the configure script rather than |
2123 | <filename>--with-croco</filename>. | 2123 | <filename>--with-croco</filename>. |
2124 | </para> | 2124 | </para> |
2125 | </glossdef> | 2125 | </glossdef> |
@@ -2138,29 +2138,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2138 | <glossentry id='var-PACKAGES_DYNAMIC'><glossterm>PACKAGES_DYNAMIC</glossterm> | 2138 | <glossentry id='var-PACKAGES_DYNAMIC'><glossterm>PACKAGES_DYNAMIC</glossterm> |
2139 | <glossdef> | 2139 | <glossdef> |
2140 | <para> | 2140 | <para> |
2141 | A promise that your recipe satisfies runtime dependencies | 2141 | A promise that your recipe satisfies runtime dependencies |
2142 | for optional modules that are found in other recipes. | 2142 | for optional modules that are found in other recipes. |
2143 | <filename>PACKAGES_DYNAMIC</filename> | 2143 | <filename>PACKAGES_DYNAMIC</filename> |
2144 | does not actually satisfy the dependencies, it only states that | 2144 | does not actually satisfy the dependencies, it only states that |
2145 | they should be satisfied. | 2145 | they should be satisfied. |
2146 | For example, if a hard, runtime dependency | 2146 | For example, if a hard, runtime dependency |
2147 | (<filename>RDEPENDS</filename>) of another package is satisfied | 2147 | (<filename>RDEPENDS</filename>) of another package is satisfied |
2148 | at build time through the <filename>PACKAGES_DYNAMIC</filename> | 2148 | at build time through the <filename>PACKAGES_DYNAMIC</filename> |
2149 | variable, but a package with the module name is never actually | 2149 | variable, but a package with the module name is never actually |
2150 | produced, then the other package will be broken. | 2150 | produced, then the other package will be broken. |
2151 | Thus, if you attempt to include that package in an image, | 2151 | Thus, if you attempt to include that package in an image, |
2152 | you will get a dependency failure from the packaging system | 2152 | you will get a dependency failure from the packaging system |
2153 | during <filename>do_rootfs</filename>. | 2153 | during <filename>do_rootfs</filename>. |
2154 | Typically, if there is a chance that such a situation can | 2154 | Typically, if there is a chance that such a situation can |
2155 | occur and the package that is not created is valid | 2155 | occur and the package that is not created is valid |
2156 | without the dependency being satisfied, then you should use | 2156 | without the dependency being satisfied, then you should use |
2157 | <filename>RRECOMMENDS</filename> (a soft runtime dependency) | 2157 | <filename>RRECOMMENDS</filename> (a soft runtime dependency) |
2158 | instead of <filename>RDEPENDS</filename>. | 2158 | instead of <filename>RDEPENDS</filename>. |
2159 | </para> | 2159 | </para> |
2160 | 2160 | ||
2161 | <para> | 2161 | <para> |
2162 | For an example of how to use the <filename>PACKAGES_DYNAMIC</filename> | 2162 | For an example of how to use the <filename>PACKAGES_DYNAMIC</filename> |
2163 | variable when you are splitting packages, see the | 2163 | variable when you are splitting packages, see the |
2164 | "<ulink url='&YOCTO_DOCS_DEV_URL;#handling-optional-module-packaging'>Handling Optional Module Packaging</ulink>" section | 2164 | "<ulink url='&YOCTO_DOCS_DEV_URL;#handling-optional-module-packaging'>Handling Optional Module Packaging</ulink>" section |
2165 | in the Yocto Project Development Manual. | 2165 | in the Yocto Project Development Manual. |
2166 | </para> | 2166 | </para> |
@@ -2169,11 +2169,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2169 | 2169 | ||
2170 | <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm> | 2170 | <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm> |
2171 | <glossdef> | 2171 | <glossdef> |
2172 | <para>Specifies extra options that are passed to the <filename>make</filename> command during the | 2172 | <para>Specifies extra options that are passed to the <filename>make</filename> command during the |
2173 | compile tasks. | 2173 | compile tasks. |
2174 | This variable is usually in the form <filename>-j 4</filename>, where the number | 2174 | This variable is usually in the form <filename>-j 4</filename>, where the number |
2175 | represents the maximum number of parallel threads make can run. | 2175 | represents the maximum number of parallel threads make can run. |
2176 | If you development host supports multiple cores a good rule of thumb is to set | 2176 | If you development host supports multiple cores a good rule of thumb is to set |
2177 | this variable to twice the number of cores on the host.</para> | 2177 | this variable to twice the number of cores on the host.</para> |
2178 | </glossdef> | 2178 | </glossdef> |
2179 | </glossentry> | 2179 | </glossentry> |
@@ -2194,21 +2194,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2194 | <glossdef> | 2194 | <glossdef> |
2195 | <para>This variable can have two separate functions depending on the context: a recipe | 2195 | <para>This variable can have two separate functions depending on the context: a recipe |
2196 | name or a resulting package name.</para> | 2196 | name or a resulting package name.</para> |
2197 | <para><filename>PN</filename> refers to a recipe name in the context of a file used | 2197 | <para><filename>PN</filename> refers to a recipe name in the context of a file used |
2198 | by the OpenEmbedded build system as input to create a package. | 2198 | by the OpenEmbedded build system as input to create a package. |
2199 | The name is normally extracted from the recipe file name. | 2199 | The name is normally extracted from the recipe file name. |
2200 | For example, if the recipe is named | 2200 | For example, if the recipe is named |
2201 | <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename> | 2201 | <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename> |
2202 | will be "expat".</para> | 2202 | will be "expat".</para> |
2203 | <para> | 2203 | <para> |
2204 | The variable refers to a package name in the context of a file created or produced by the | 2204 | The variable refers to a package name in the context of a file created or produced by the |
2205 | OpenEmbedded build system.</para> | 2205 | OpenEmbedded build system.</para> |
2206 | <para>If applicable, the <filename>PN</filename> variable also contains any special | 2206 | <para>If applicable, the <filename>PN</filename> variable also contains any special |
2207 | suffix or prefix. | 2207 | suffix or prefix. |
2208 | For example, using <filename>bash</filename> to build packages for the native | 2208 | For example, using <filename>bash</filename> to build packages for the native |
2209 | machine, <filename>PN</filename> is <filename>bash-native</filename>. | 2209 | machine, <filename>PN</filename> is <filename>bash-native</filename>. |
2210 | Using <filename>bash</filename> to build packages for the target and for Multilib, | 2210 | Using <filename>bash</filename> to build packages for the target and for Multilib, |
2211 | <filename>PN</filename> would be <filename>bash</filename> and | 2211 | <filename>PN</filename> would be <filename>bash</filename> and |
2212 | <filename>lib64-bash</filename>, respectively. | 2212 | <filename>lib64-bash</filename>, respectively. |
2213 | </para> | 2213 | </para> |
2214 | </glossdef> | 2214 | </glossdef> |
@@ -2216,7 +2216,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2216 | 2216 | ||
2217 | <glossentry id='var-PR'><glossterm>PR</glossterm> | 2217 | <glossentry id='var-PR'><glossterm>PR</glossterm> |
2218 | <glossdef> | 2218 | <glossdef> |
2219 | <para>The revision of the recipe. | 2219 | <para>The revision of the recipe. |
2220 | The default value for this variable is "r0". | 2220 | The default value for this variable is "r0". |
2221 | </para> | 2221 | </para> |
2222 | </glossdef> | 2222 | </glossdef> |
@@ -2224,10 +2224,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2224 | 2224 | ||
2225 | <glossentry id='var-PRINC'><glossterm>PRINC</glossterm> | 2225 | <glossentry id='var-PRINC'><glossterm>PRINC</glossterm> |
2226 | <glossdef> | 2226 | <glossdef> |
2227 | <para>Causes the <filename>PR</filename> variable of | 2227 | <para>Causes the <filename>PR</filename> variable of |
2228 | <filename>.bbappend</filename> files to dynamically increment. | 2228 | <filename>.bbappend</filename> files to dynamically increment. |
2229 | This increment minimizes the impact of layer ordering.</para> | 2229 | This increment minimizes the impact of layer ordering.</para> |
2230 | <para>In order to ensure multiple <filename>.bbappend</filename> files can co-exist, | 2230 | <para>In order to ensure multiple <filename>.bbappend</filename> files can co-exist, |
2231 | <filename>PRINC</filename> should be self referencing. | 2231 | <filename>PRINC</filename> should be self referencing. |
2232 | This variable defaults to 0.</para> | 2232 | This variable defaults to 0.</para> |
2233 | <para>Following is an example that increments <filename>PR</filename> by two: | 2233 | <para>Following is an example that increments <filename>PR</filename> by two: |
@@ -2235,8 +2235,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2235 | PRINC := "${@int(PRINC) + 2}" | 2235 | PRINC := "${@int(PRINC) + 2}" |
2236 | </literallayout> | 2236 | </literallayout> |
2237 | It is adviseable not to use strings such as ".= '.1'" with the variable because | 2237 | It is adviseable not to use strings such as ".= '.1'" with the variable because |
2238 | this usage is very sensitive to layer ordering. | 2238 | this usage is very sensitive to layer ordering. |
2239 | Explicit assignments should be avoided as they cannot adequately represent multiple | 2239 | Explicit assignments should be avoided as they cannot adequately represent multiple |
2240 | <filename>.bbappend</filename> files.</para> | 2240 | <filename>.bbappend</filename> files.</para> |
2241 | </glossdef> | 2241 | </glossdef> |
2242 | </glossentry> | 2242 | </glossentry> |
@@ -2245,11 +2245,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2245 | <glossdef> | 2245 | <glossdef> |
2246 | <para>The version of the recipe. | 2246 | <para>The version of the recipe. |
2247 | The version is normally extracted from the recipe filename. | 2247 | The version is normally extracted from the recipe filename. |
2248 | For example, if the recipe is named | 2248 | For example, if the recipe is named |
2249 | <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PV</filename> | 2249 | <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PV</filename> |
2250 | will be "2.0.1". | 2250 | will be "2.0.1". |
2251 | <filename>PV</filename> is generally not overridden within | 2251 | <filename>PV</filename> is generally not overridden within |
2252 | a recipe unless it is building an unstable (i.e. development) version from a source code repository | 2252 | a recipe unless it is building an unstable (i.e. development) version from a source code repository |
2253 | (e.g. Git or Subversion). | 2253 | (e.g. Git or Subversion). |
2254 | </para> | 2254 | </para> |
2255 | </glossdef> | 2255 | </glossdef> |
@@ -2258,9 +2258,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2258 | <glossentry id='var-PE'><glossterm>PE</glossterm> | 2258 | <glossentry id='var-PE'><glossterm>PE</glossterm> |
2259 | <glossdef> | 2259 | <glossdef> |
2260 | <para> | 2260 | <para> |
2261 | the epoch of the recipe. | 2261 | the epoch of the recipe. |
2262 | The default value is "0". | 2262 | The default value is "0". |
2263 | The field is used to make upgrades possible when the versioning scheme changes in | 2263 | The field is used to make upgrades possible when the versioning scheme changes in |
2264 | some backwards incompatible way. | 2264 | some backwards incompatible way. |
2265 | </para> | 2265 | </para> |
2266 | </glossdef> | 2266 | </glossdef> |
@@ -2270,10 +2270,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2270 | <glossdef> | 2270 | <glossdef> |
2271 | <para> | 2271 | <para> |
2272 | If multiple recipes provide an item, this variable | 2272 | If multiple recipes provide an item, this variable |
2273 | determines which recipe should be given preference. | 2273 | determines which recipe should be given preference. |
2274 | The variable must always be suffixed with the name of the | 2274 | The variable must always be suffixed with the name of the |
2275 | provided item, and should be set to the | 2275 | provided item, and should be set to the |
2276 | <filename>PN</filename> of the recipe | 2276 | <filename>PN</filename> of the recipe |
2277 | to which you want to give precedence. | 2277 | to which you want to give precedence. |
2278 | Here is an example: | 2278 | Here is an example: |
2279 | <literallayout class='monospaced'> | 2279 | <literallayout class='monospaced'> |
@@ -2288,17 +2288,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2288 | <para> | 2288 | <para> |
2289 | If there are multiple versions of recipes available, this | 2289 | If there are multiple versions of recipes available, this |
2290 | variable determines which recipe should be given preference. | 2290 | variable determines which recipe should be given preference. |
2291 | The variable must always be suffixed with the <filename>PN</filename> | 2291 | The variable must always be suffixed with the <filename>PN</filename> |
2292 | for which to select, and should be set to the | 2292 | for which to select, and should be set to the |
2293 | <filename>PV</filename> to which you want to give precedence. | 2293 | <filename>PV</filename> to which you want to give precedence. |
2294 | You can use the "<filename>%</filename>" character as a wildcard | 2294 | You can use the "<filename>%</filename>" character as a wildcard |
2295 | to match any number of characters, which can be useful when | 2295 | to match any number of characters, which can be useful when |
2296 | specifying versions that contain long revision number that could | 2296 | specifying versions that contain long revision number that could |
2297 | potentially change. | 2297 | potentially change. |
2298 | Here are two examples: | 2298 | Here are two examples: |
2299 | <literallayout class='monospaced'> | 2299 | <literallayout class='monospaced'> |
2300 | PREFERRED_VERSION_python = "2.6.6" | 2300 | PREFERRED_VERSION_python = "2.6.6" |
2301 | PREFERRED_VERSION_linux-yocto = "3.0+git%" | 2301 | PREFERRED_VERSION_linux-yocto = "3.0+git%" |
2302 | </literallayout> | 2302 | </literallayout> |
2303 | </para> | 2303 | </para> |
2304 | </glossdef> | 2304 | </glossdef> |
@@ -2317,7 +2317,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2317 | Note that the package will not be installed if the conflicting packages are not | 2317 | Note that the package will not be installed if the conflicting packages are not |
2318 | first removed.</para> | 2318 | first removed.</para> |
2319 | <para> | 2319 | <para> |
2320 | Like all package-controlling variables, you must always use them in | 2320 | Like all package-controlling variables, you must always use them in |
2321 | conjunction with a package name override. | 2321 | conjunction with a package name override. |
2322 | Here is an example: | 2322 | Here is an example: |
2323 | <literallayout class='monospaced'> | 2323 | <literallayout class='monospaced'> |
@@ -2330,59 +2330,59 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2330 | <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm> | 2330 | <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm> |
2331 | <glossdef> | 2331 | <glossdef> |
2332 | <para> | 2332 | <para> |
2333 | Lists a package's run-time dependencies (i.e. other packages) | 2333 | Lists a package's run-time dependencies (i.e. other packages) |
2334 | that must be installed for the package to be built. | 2334 | that must be installed for the package to be built. |
2335 | In other words, in order for the package to be built and | 2335 | In other words, in order for the package to be built and |
2336 | run correctly, it depends on the listed packages. | 2336 | run correctly, it depends on the listed packages. |
2337 | If a package in this list cannot be found, it is probable | 2337 | If a package in this list cannot be found, it is probable |
2338 | that a dependency error would occur before the build. | 2338 | that a dependency error would occur before the build. |
2339 | </para> | 2339 | </para> |
2340 | 2340 | ||
2341 | <para> | 2341 | <para> |
2342 | The names of the variables you list with | 2342 | The names of the variables you list with |
2343 | <filename>RDEPENDS</filename> must be the names of other | 2343 | <filename>RDEPENDS</filename> must be the names of other |
2344 | packages as listed in the | 2344 | packages as listed in the |
2345 | <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> | 2345 | <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> |
2346 | variable. | 2346 | variable. |
2347 | You should not list recipe names (<filename>PN</filename>). | 2347 | You should not list recipe names (<filename>PN</filename>). |
2348 | </para> | 2348 | </para> |
2349 | 2349 | ||
2350 | <para> | 2350 | <para> |
2351 | Because the <filename>RDEPENDS</filename> variable applies | 2351 | Because the <filename>RDEPENDS</filename> variable applies |
2352 | to packages being built, you should | 2352 | to packages being built, you should |
2353 | always attach a package name to the variable to specify the | 2353 | always attach a package name to the variable to specify the |
2354 | particular run-time package that has the dependency. | 2354 | particular run-time package that has the dependency. |
2355 | For example, suppose you are building a development package | 2355 | For example, suppose you are building a development package |
2356 | that depends on the <filename>perl</filename> package. | 2356 | that depends on the <filename>perl</filename> package. |
2357 | In this case, you would use the following | 2357 | In this case, you would use the following |
2358 | <filename>RDEPENDS</filename> statement: | 2358 | <filename>RDEPENDS</filename> statement: |
2359 | <literallayout class='monospaced'> | 2359 | <literallayout class='monospaced'> |
2360 | RDEPENDS_${PN}-dev += "perl" | 2360 | RDEPENDS_${PN}-dev += "perl" |
2361 | </literallayout> | 2361 | </literallayout> |
2362 | In the example, the package name | 2362 | In the example, the package name |
2363 | (<filename>${PN}-dev</filename>) must appear as it would | 2363 | (<filename>${PN}-dev</filename>) must appear as it would |
2364 | in the | 2364 | in the |
2365 | <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> | 2365 | <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> |
2366 | namespace before any renaming of the output package by | 2366 | namespace before any renaming of the output package by |
2367 | classes like <filename>debian.bbclass</filename>. | 2367 | classes like <filename>debian.bbclass</filename>. |
2368 | </para> | 2368 | </para> |
2369 | 2369 | ||
2370 | <para> | 2370 | <para> |
2371 | In many cases you do not need to explicitly add dependencies | 2371 | In many cases you do not need to explicitly add dependencies |
2372 | to <filename>RDEPENDS</filename> since some automatic | 2372 | to <filename>RDEPENDS</filename> since some automatic |
2373 | handling occurs: | 2373 | handling occurs: |
2374 | <itemizedlist> | 2374 | <itemizedlist> |
2375 | <listitem><para><emphasis><filename>shlibdeps</filename></emphasis>: If | 2375 | <listitem><para><emphasis><filename>shlibdeps</filename></emphasis>: If |
2376 | a run-time package contains a shared library | 2376 | a run-time package contains a shared library |
2377 | (<filename>.so</filename>), the build | 2377 | (<filename>.so</filename>), the build |
2378 | processes the library in order to determine other | 2378 | processes the library in order to determine other |
2379 | libraries to which it is dynamically linked. | 2379 | libraries to which it is dynamically linked. |
2380 | The build process adds these libraries to | 2380 | The build process adds these libraries to |
2381 | <filename>RDEPENDS</filename> when creating the run-time | 2381 | <filename>RDEPENDS</filename> when creating the run-time |
2382 | package.</para></listitem> | 2382 | package.</para></listitem> |
2383 | <listitem><para><emphasis><filename>pcdeps</filename></emphasis>: If | 2383 | <listitem><para><emphasis><filename>pcdeps</filename></emphasis>: If |
2384 | the package ships a <filename>pkg-config</filename> | 2384 | the package ships a <filename>pkg-config</filename> |
2385 | information file, the build process uses this file | 2385 | information file, the build process uses this file |
2386 | to add items to the <filename>RDEPENDS</filename> | 2386 | to add items to the <filename>RDEPENDS</filename> |
2387 | variable to create the run-time packages. | 2387 | variable to create the run-time packages. |
2388 | </para></listitem> | 2388 | </para></listitem> |
@@ -2394,11 +2394,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2394 | <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm> | 2394 | <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm> |
2395 | <glossdef> | 2395 | <glossdef> |
2396 | <para> | 2396 | <para> |
2397 | A list of packages that extend the usability of a package being | 2397 | A list of packages that extend the usability of a package being |
2398 | built. | 2398 | built. |
2399 | The package being built does not depend on this list of packages in | 2399 | The package being built does not depend on this list of packages in |
2400 | order to successfully build, but needs them for the extended usability. | 2400 | order to successfully build, but needs them for the extended usability. |
2401 | To specify runtime dependencies for packages, see the | 2401 | To specify runtime dependencies for packages, see the |
2402 | <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variable. | 2402 | <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variable. |
2403 | </para> | 2403 | </para> |
2404 | <para> | 2404 | <para> |
@@ -2409,8 +2409,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2409 | process continues without an error. | 2409 | process continues without an error. |
2410 | </para> | 2410 | </para> |
2411 | <para> | 2411 | <para> |
2412 | Because the <filename>RRECOMMENDS</filename> variable applies to packages | 2412 | Because the <filename>RRECOMMENDS</filename> variable applies to packages |
2413 | being built, you should | 2413 | being built, you should |
2414 | always attach an override to the variable to specify the particular package | 2414 | always attach an override to the variable to specify the particular package |
2415 | whose usability is being extended. | 2415 | whose usability is being extended. |
2416 | For example, suppose you are building a development package that is extended | 2416 | For example, suppose you are building a development package that is extended |
@@ -2419,9 +2419,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2419 | <literallayout class='monospaced'> | 2419 | <literallayout class='monospaced'> |
2420 | RRECOMMENDS_${PN}-dev += "<wireless_package_name>" | 2420 | RRECOMMENDS_${PN}-dev += "<wireless_package_name>" |
2421 | </literallayout> | 2421 | </literallayout> |
2422 | In the example, the package name (<filename>${PN}-dev</filename>) must | 2422 | In the example, the package name (<filename>${PN}-dev</filename>) must |
2423 | appear as it would in the | 2423 | appear as it would in the |
2424 | <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> namespace before any | 2424 | <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> namespace before any |
2425 | renaming of the output package by classes like <filename>debian.bbclass</filename>. | 2425 | renaming of the output package by classes like <filename>debian.bbclass</filename>. |
2426 | </para> | 2426 | </para> |
2427 | </glossdef> | 2427 | </glossdef> |
@@ -2442,22 +2442,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2442 | <para> | 2442 | <para> |
2443 | The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 2443 | The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
2444 | where unpacked package source code resides. | 2444 | where unpacked package source code resides. |
2445 | This location is within the working directory | 2445 | This location is within the working directory |
2446 | (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which | 2446 | (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which |
2447 | is not static. | 2447 | is not static. |
2448 | The unpacked source location depends on the package name | 2448 | The unpacked source location depends on the package name |
2449 | (<filename><link linkend='var-PN'>PN</link></filename>) and | 2449 | (<filename><link linkend='var-PN'>PN</link></filename>) and |
2450 | package version (<filename><link linkend='var-PV'>PV</link></filename>) as | 2450 | package version (<filename><link linkend='var-PV'>PV</link></filename>) as |
2451 | follows: | 2451 | follows: |
2452 | <literallayout class='monospaced'> | 2452 | <literallayout class='monospaced'> |
2453 | ${WORKDIR}/${PN}-${PV} | 2453 | ${WORKDIR}/${PN}-${PV} |
2454 | </literallayout> | 2454 | </literallayout> |
2455 | As an example, assume a | 2455 | As an example, assume a |
2456 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level | 2456 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level |
2457 | folder named <filename>poky</filename> | 2457 | folder named <filename>poky</filename> |
2458 | and a default <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 2458 | and a default <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
2459 | at <filename>poky/build</filename>. | 2459 | at <filename>poky/build</filename>. |
2460 | In this case, the working directory the build system uses to build | 2460 | In this case, the working directory the build system uses to build |
2461 | the <filename>db</filename> package is the following: | 2461 | the <filename>db</filename> package is the following: |
2462 | <literallayout class='monospaced'> | 2462 | <literallayout class='monospaced'> |
2463 | ~/poky/build/tmp/work/qemux86-poky-linux/db-5.1.19-r3/db-5.1.19 | 2463 | ~/poky/build/tmp/work/qemux86-poky-linux/db-5.1.19-r3/db-5.1.19 |
@@ -2468,9 +2468,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2468 | 2468 | ||
2469 | <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm> | 2469 | <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm> |
2470 | <glossdef> | 2470 | <glossdef> |
2471 | <para>Equivalent to | 2471 | <para>Equivalent to |
2472 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>. | 2472 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>. |
2473 | However, this variable applies to the SDK generated from an image using | 2473 | However, this variable applies to the SDK generated from an image using |
2474 | <filename>bitbake -c populate_sdk imagename</filename>). | 2474 | <filename>bitbake -c populate_sdk imagename</filename>). |
2475 | </para> | 2475 | </para> |
2476 | </glossdef> | 2476 | </glossdef> |
@@ -2486,10 +2486,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2486 | <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm> | 2486 | <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm> |
2487 | <glossdef> | 2487 | <glossdef> |
2488 | <para> | 2488 | <para> |
2489 | The variable takes the value of | 2489 | The variable takes the value of |
2490 | <filename><link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link></filename> | 2490 | <filename><link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link></filename> |
2491 | unless <filename><link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link></filename> = "1". | 2491 | unless <filename><link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link></filename> = "1". |
2492 | In this case the value of | 2492 | In this case the value of |
2493 | <filename><link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link></filename> is used. | 2493 | <filename><link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link></filename> is used. |
2494 | </para> | 2494 | </para> |
2495 | </glossdef> | 2495 | </glossdef> |
@@ -2498,7 +2498,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2498 | 2498 | ||
2499 | <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm> | 2499 | <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm> |
2500 | <glossdef> | 2500 | <glossdef> |
2501 | <para>The speed and device for the serial port used to attach the serial console. | 2501 | <para>The speed and device for the serial port used to attach the serial console. |
2502 | This variable is given to the kernel as the "console" | 2502 | This variable is given to the kernel as the "console" |
2503 | parameter and after booting occurs <filename>getty</filename> is started on that port | 2503 | parameter and after booting occurs <filename>getty</filename> is started on that port |
2504 | so remote login is possible.</para> | 2504 | so remote login is possible.</para> |
@@ -2508,7 +2508,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2508 | <glossentry id='var-SITEINFO_ENDIANNESS'><glossterm>SITEINFO_ENDIANNESS</glossterm> | 2508 | <glossentry id='var-SITEINFO_ENDIANNESS'><glossterm>SITEINFO_ENDIANNESS</glossterm> |
2509 | <glossdef> | 2509 | <glossdef> |
2510 | <para> | 2510 | <para> |
2511 | Specifies the endian byte order of the target system. | 2511 | Specifies the endian byte order of the target system. |
2512 | The value should be either "le" for little-endian or "be" for big-endian. | 2512 | The value should be either "le" for little-endian or "be" for big-endian. |
2513 | </para> | 2513 | </para> |
2514 | </glossdef> | 2514 | </glossdef> |
@@ -2526,7 +2526,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2526 | <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm> | 2526 | <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm> |
2527 | <glossdef> | 2527 | <glossdef> |
2528 | <para> | 2528 | <para> |
2529 | A list of prefixes for <link linkend='var-PN'><filename>PN</filename></link> used by the | 2529 | A list of prefixes for <link linkend='var-PN'><filename>PN</filename></link> used by the |
2530 | OpenEmbedded build system to create variants of recipes or packages. | 2530 | OpenEmbedded build system to create variants of recipes or packages. |
2531 | The list specifies the prefixes to strip off during certain circumstances | 2531 | The list specifies the prefixes to strip off during certain circumstances |
2532 | such as the generation of the <link linkend='var-BPN'><filename>BPN</filename></link> variable. | 2532 | such as the generation of the <link linkend='var-BPN'><filename>BPN</filename></link> variable. |
@@ -2539,7 +2539,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2539 | <para>The list of source files - local or remote. | 2539 | <para>The list of source files - local or remote. |
2540 | This variable tells the OpenEmbedded build system which bits to pull | 2540 | This variable tells the OpenEmbedded build system which bits to pull |
2541 | in for the build and how to pull them in. | 2541 | in for the build and how to pull them in. |
2542 | For example, if the recipe only needs to fetch a tarball from the | 2542 | For example, if the recipe only needs to fetch a tarball from the |
2543 | internet, the recipe uses a single <filename>SRC_URI</filename> entry. | 2543 | internet, the recipe uses a single <filename>SRC_URI</filename> entry. |
2544 | On the other hand, if the recipe needs to fetch a tarball, apply | 2544 | On the other hand, if the recipe needs to fetch a tarball, apply |
2545 | two patches, and include a custom file, the recipe would include four | 2545 | two patches, and include a custom file, the recipe would include four |
@@ -2547,120 +2547,120 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2547 | <para>The following list explains the available URI protocols: | 2547 | <para>The following list explains the available URI protocols: |
2548 | <itemizedlist> | 2548 | <itemizedlist> |
2549 | <listitem><para><emphasis><filename>file://</filename> -</emphasis> Fetches files, which is usually | 2549 | <listitem><para><emphasis><filename>file://</filename> -</emphasis> Fetches files, which is usually |
2550 | a file shipped with the metadata, from the local machine. | 2550 | a file shipped with the metadata, from the local machine. |
2551 | The path is relative to the | 2551 | The path is relative to the |
2552 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> | 2552 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> |
2553 | variable. | 2553 | variable. |
2554 | Thus, the build system searches, in order, from the following directories, | 2554 | Thus, the build system searches, in order, from the following directories, |
2555 | which are assumed to be a subdirectories of the directory in which the | 2555 | which are assumed to be a subdirectories of the directory in which the |
2556 | recipe file resides: | 2556 | recipe file resides: |
2557 | <itemizedlist> | 2557 | <itemizedlist> |
2558 | <listitem><para><emphasis><filename>${PN}</filename> -</emphasis> The recipe name | 2558 | <listitem><para><emphasis><filename>${PN}</filename> -</emphasis> The recipe name |
2559 | with any special suffix or prefix, if applicable. | 2559 | with any special suffix or prefix, if applicable. |
2560 | For example, using <filename>bash</filename> to build for the native | 2560 | For example, using <filename>bash</filename> to build for the native |
2561 | machine, <filename>PN</filename> is <filename>bash-native</filename>. | 2561 | machine, <filename>PN</filename> is <filename>bash-native</filename>. |
2562 | Using <filename>bash</filename> to build for the target and for Multilib, | 2562 | Using <filename>bash</filename> to build for the target and for Multilib, |
2563 | <filename>PN</filename> would be <filename>bash</filename> and | 2563 | <filename>PN</filename> would be <filename>bash</filename> and |
2564 | <filename>lib64-bash</filename>, respectively. | 2564 | <filename>lib64-bash</filename>, respectively. |
2565 | </para></listitem> | 2565 | </para></listitem> |
2566 | <listitem><para><emphasis><filename>${PF}</filename> - </emphasis> | 2566 | <listitem><para><emphasis><filename>${PF}</filename> - </emphasis> |
2567 | <filename>${PN}-${EXTENDPE}${PV}-${PR}</filename>. | 2567 | <filename>${PN}-${EXTENDPE}${PV}-${PR}</filename>. |
2568 | The recipe name including all version and revision numbers | 2568 | The recipe name including all version and revision numbers |
2569 | (i.e. <filename>eglibc-2.13-r20+svnr15508/</filename> and | 2569 | (i.e. <filename>eglibc-2.13-r20+svnr15508/</filename> and |
2570 | <filename>bash-4.2-r1/</filename>).</para></listitem> | 2570 | <filename>bash-4.2-r1/</filename>).</para></listitem> |
2571 | <listitem><para><emphasis><filename>${P}</filename> -</emphasis> | 2571 | <listitem><para><emphasis><filename>${P}</filename> -</emphasis> |
2572 | <filename>${PN}-${PV}</filename>. | 2572 | <filename>${PN}-${PV}</filename>. |
2573 | The recipe name and version (i.e. <filename>bash-4.2</filename>). | 2573 | The recipe name and version (i.e. <filename>bash-4.2</filename>). |
2574 | </para></listitem> | 2574 | </para></listitem> |
2575 | <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> The | 2575 | <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> The |
2576 | base recipe name without any special suffix or version numbers. | 2576 | base recipe name without any special suffix or version numbers. |
2577 | </para></listitem> | 2577 | </para></listitem> |
2578 | <listitem><para><emphasis><filename>${BP}</filename> -</emphasis> | 2578 | <listitem><para><emphasis><filename>${BP}</filename> -</emphasis> |
2579 | <filename>${BPN}-${PV}</filename>. | 2579 | <filename>${BPN}-${PV}</filename>. |
2580 | The base recipe name and version but without any special | 2580 | The base recipe name and version but without any special |
2581 | package name suffix.</para></listitem> | 2581 | package name suffix.</para></listitem> |
2582 | <listitem><para><emphasis>Files -</emphasis> Files beneath the directory in which the recipe | 2582 | <listitem><para><emphasis>Files -</emphasis> Files beneath the directory in which the recipe |
2583 | resides.</para></listitem> | 2583 | resides.</para></listitem> |
2584 | <listitem><para><emphasis>Directory -</emphasis> The directory itself in which the recipe | 2584 | <listitem><para><emphasis>Directory -</emphasis> The directory itself in which the recipe |
2585 | resides.</para></listitem> | 2585 | resides.</para></listitem> |
2586 | </itemizedlist></para></listitem> | 2586 | </itemizedlist></para></listitem> |
2587 | <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a | 2587 | <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a |
2588 | Bazaar revision control repository.</para></listitem> | 2588 | Bazaar revision control repository.</para></listitem> |
2589 | <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a | 2589 | <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a |
2590 | Git revision control repository.</para></listitem> | 2590 | Git revision control repository.</para></listitem> |
2591 | <listitem><para><emphasis><filename>osc://</filename> -</emphasis> Fetches files from | 2591 | <listitem><para><emphasis><filename>osc://</filename> -</emphasis> Fetches files from |
2592 | an OSC (OpenSuse Build service) revision control repository.</para></listitem> | 2592 | an OSC (OpenSuse Build service) revision control repository.</para></listitem> |
2593 | <listitem><para><emphasis><filename>repo://</filename> -</emphasis> Fetches files from | 2593 | <listitem><para><emphasis><filename>repo://</filename> -</emphasis> Fetches files from |
2594 | a repo (Git) repository.</para></listitem> | 2594 | a repo (Git) repository.</para></listitem> |
2595 | <listitem><para><emphasis><filename>svk://</filename> -</emphasis> Fetches files from | 2595 | <listitem><para><emphasis><filename>svk://</filename> -</emphasis> Fetches files from |
2596 | an SVK revision control repository.</para></listitem> | 2596 | an SVK revision control repository.</para></listitem> |
2597 | <listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from | 2597 | <listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from |
2598 | the Internet using <filename>http</filename>.</para></listitem> | 2598 | the Internet using <filename>http</filename>.</para></listitem> |
2599 | <listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files | 2599 | <listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files |
2600 | from the Internet using <filename>https</filename>.</para></listitem> | 2600 | from the Internet using <filename>https</filename>.</para></listitem> |
2601 | <listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files | 2601 | <listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files |
2602 | from the Internet using <filename>ftp</filename>.</para></listitem> | 2602 | from the Internet using <filename>ftp</filename>.</para></listitem> |
2603 | <listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from | 2603 | <listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from |
2604 | a CVS revision control repository.</para></listitem> | 2604 | a CVS revision control repository.</para></listitem> |
2605 | <listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from | 2605 | <listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from |
2606 | a Mercurial (<filename>hg</filename>) revision control repository.</para></listitem> | 2606 | a Mercurial (<filename>hg</filename>) revision control repository.</para></listitem> |
2607 | <listitem><para><emphasis><filename>p4://</filename> -</emphasis> Fetches files from | 2607 | <listitem><para><emphasis><filename>p4://</filename> -</emphasis> Fetches files from |
2608 | a Perforce (<filename>p4</filename>) revision control repository.</para></listitem> | 2608 | a Perforce (<filename>p4</filename>) revision control repository.</para></listitem> |
2609 | <listitem><para><emphasis><filename>ssh://</filename> -</emphasis> Fetches files from | 2609 | <listitem><para><emphasis><filename>ssh://</filename> -</emphasis> Fetches files from |
2610 | a secure shell.</para></listitem> | 2610 | a secure shell.</para></listitem> |
2611 | <listitem><para><emphasis><filename>svn://</filename> -</emphasis> Fetches files from | 2611 | <listitem><para><emphasis><filename>svn://</filename> -</emphasis> Fetches files from |
2612 | a Subversion (<filename>svn</filename>) revision control repository.</para></listitem> | 2612 | a Subversion (<filename>svn</filename>) revision control repository.</para></listitem> |
2613 | </itemizedlist> | 2613 | </itemizedlist> |
2614 | </para> | 2614 | </para> |
2615 | <para>Standard and recipe-specific options for <filename>SRC_URI</filename> exist. | 2615 | <para>Standard and recipe-specific options for <filename>SRC_URI</filename> exist. |
2616 | Here are standard options: | 2616 | Here are standard options: |
2617 | <itemizedlist> | 2617 | <itemizedlist> |
2618 | <listitem><para><emphasis><filename>apply</filename> -</emphasis> Whether to apply | 2618 | <listitem><para><emphasis><filename>apply</filename> -</emphasis> Whether to apply |
2619 | the patch or not. | 2619 | the patch or not. |
2620 | The default action is to apply the patch.</para></listitem> | 2620 | The default action is to apply the patch.</para></listitem> |
2621 | <listitem><para><emphasis><filename>striplevel</filename> -</emphasis> Which | 2621 | <listitem><para><emphasis><filename>striplevel</filename> -</emphasis> Which |
2622 | striplevel to use when applying the patch. | 2622 | striplevel to use when applying the patch. |
2623 | The default level is 1.</para></listitem> | 2623 | The default level is 1.</para></listitem> |
2624 | </itemizedlist> | 2624 | </itemizedlist> |
2625 | </para> | 2625 | </para> |
2626 | <para>Here are options specific to recipes building code from a revision control system: | 2626 | <para>Here are options specific to recipes building code from a revision control system: |
2627 | <itemizedlist> | 2627 | <itemizedlist> |
2628 | <listitem><para><emphasis><filename>mindate</filename> -</emphasis> Only applies | 2628 | <listitem><para><emphasis><filename>mindate</filename> -</emphasis> Only applies |
2629 | the patch if <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link> | 2629 | the patch if <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link> |
2630 | is equal to or greater than <filename>mindate</filename>.</para></listitem> | 2630 | is equal to or greater than <filename>mindate</filename>.</para></listitem> |
2631 | <listitem><para><emphasis><filename>maxdate</filename> -</emphasis> Only applies | 2631 | <listitem><para><emphasis><filename>maxdate</filename> -</emphasis> Only applies |
2632 | the patch if <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link> | 2632 | the patch if <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link> |
2633 | is not later than <filename>mindate</filename>.</para></listitem> | 2633 | is not later than <filename>mindate</filename>.</para></listitem> |
2634 | <listitem><para><emphasis><filename>minrev</filename> -</emphasis> Only applies | 2634 | <listitem><para><emphasis><filename>minrev</filename> -</emphasis> Only applies |
2635 | the patch if <link linkend='var-SRCREV'><filename>SRCREV</filename></link> | 2635 | the patch if <link linkend='var-SRCREV'><filename>SRCREV</filename></link> |
2636 | is equal to or greater than <filename>minrev</filename>.</para></listitem> | 2636 | is equal to or greater than <filename>minrev</filename>.</para></listitem> |
2637 | <listitem><para><emphasis><filename>maxrev</filename> -</emphasis> Only applies | 2637 | <listitem><para><emphasis><filename>maxrev</filename> -</emphasis> Only applies |
2638 | the patch if <link linkend='var-SRCREV'><filename>SRCREV</filename></link> | 2638 | the patch if <link linkend='var-SRCREV'><filename>SRCREV</filename></link> |
2639 | is not later than <filename>maxrev</filename>.</para></listitem> | 2639 | is not later than <filename>maxrev</filename>.</para></listitem> |
2640 | <listitem><para><emphasis><filename>rev</filename> -</emphasis> Only applies the | 2640 | <listitem><para><emphasis><filename>rev</filename> -</emphasis> Only applies the |
2641 | patch if <link linkend='var-SRCREV'><filename>SRCREV</filename></link> | 2641 | patch if <link linkend='var-SRCREV'><filename>SRCREV</filename></link> |
2642 | is equal to <filename>rev</filename>.</para></listitem> | 2642 | is equal to <filename>rev</filename>.</para></listitem> |
2643 | <listitem><para><emphasis><filename>notrev</filename> -</emphasis> Only applies | 2643 | <listitem><para><emphasis><filename>notrev</filename> -</emphasis> Only applies |
2644 | the patch if <link linkend='var-SRCREV'><filename>SRCREV</filename></link> | 2644 | the patch if <link linkend='var-SRCREV'><filename>SRCREV</filename></link> |
2645 | is not equal to <filename>rev</filename>.</para></listitem> | 2645 | is not equal to <filename>rev</filename>.</para></listitem> |
2646 | </itemizedlist> | 2646 | </itemizedlist> |
2647 | </para> | 2647 | </para> |
2648 | <para>Here are some additional options worth mentioning: | 2648 | <para>Here are some additional options worth mentioning: |
2649 | <itemizedlist> | 2649 | <itemizedlist> |
2650 | <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls | 2650 | <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls |
2651 | whether or not to unpack the file if it is an archive. | 2651 | whether or not to unpack the file if it is an archive. |
2652 | The default action is to upack the file.</para></listitem> | 2652 | The default action is to upack the file.</para></listitem> |
2653 | <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file | 2653 | <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file |
2654 | (or extracts its contents) into the specified | 2654 | (or extracts its contents) into the specified |
2655 | subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. | 2655 | subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. |
2656 | This option is useful for unusual tarballs or other archives that | 2656 | This option is useful for unusual tarballs or other archives that |
2657 | don't have their files already in a subdirectory within the archive. | 2657 | don't have their files already in a subdirectory within the archive. |
2658 | </para></listitem> | 2658 | </para></listitem> |
2659 | <listitem><para><emphasis><filename>name</filename> -</emphasis> Specifies a | 2659 | <listitem><para><emphasis><filename>name</filename> -</emphasis> Specifies a |
2660 | name to be used for association with <filename>SRC_URI</filename> checksums | 2660 | name to be used for association with <filename>SRC_URI</filename> checksums |
2661 | when you have more than one file specified in <filename>SRC_URI</filename>. | 2661 | when you have more than one file specified in <filename>SRC_URI</filename>. |
2662 | </para></listitem> | 2662 | </para></listitem> |
2663 | <listitem><para><emphasis><filename>downloadfilename</filename> -</emphasis> Specifies | 2663 | <listitem><para><emphasis><filename>downloadfilename</filename> -</emphasis> Specifies |
2664 | the filename used when storing the downloaded file.</para></listitem> | 2664 | the filename used when storing the downloaded file.</para></listitem> |
2665 | </itemizedlist> | 2665 | </itemizedlist> |
2666 | </para> | 2666 | </para> |
@@ -2671,11 +2671,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2671 | <glossdef> | 2671 | <glossdef> |
2672 | <para></para> | 2672 | <para></para> |
2673 | <para> | 2673 | <para> |
2674 | By default, the OpenEmbedded build system automatically detects whether | 2674 | By default, the OpenEmbedded build system automatically detects whether |
2675 | <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> | 2675 | <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> |
2676 | contains files that are machine-specific. | 2676 | contains files that are machine-specific. |
2677 | If so, the build system automatically changes | 2677 | If so, the build system automatically changes |
2678 | <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>. | 2678 | <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>. |
2679 | Setting this variable to "0" disables this behavior. | 2679 | Setting this variable to "0" disables this behavior. |
2680 | </para> | 2680 | </para> |
2681 | </glossdef> | 2681 | </glossdef> |
@@ -2695,7 +2695,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2695 | <para> | 2695 | <para> |
2696 | The revision of the source code used to build the package. | 2696 | The revision of the source code used to build the package. |
2697 | This variable applies to Subversion, Git, Mercurial and Bazaar | 2697 | This variable applies to Subversion, Git, Mercurial and Bazaar |
2698 | only. | 2698 | only. |
2699 | Note that if you wish to build a fixed revision and you wish | 2699 | Note that if you wish to build a fixed revision and you wish |
2700 | to avoid performing a query on the remote repository every time | 2700 | to avoid performing a query on the remote repository every time |
2701 | BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a | 2701 | BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a |
@@ -2713,30 +2713,30 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2713 | <glossentry id='var-SSTATE_MIRRORS'><glossterm>SSTATE_MIRRORS</glossterm> | 2713 | <glossentry id='var-SSTATE_MIRRORS'><glossterm>SSTATE_MIRRORS</glossterm> |
2714 | <glossdef> | 2714 | <glossdef> |
2715 | <para> | 2715 | <para> |
2716 | Configures the OpenEmbedded build system to search other | 2716 | Configures the OpenEmbedded build system to search other |
2717 | mirror locations for prebuilt cache data objects before | 2717 | mirror locations for prebuilt cache data objects before |
2718 | building out the data. | 2718 | building out the data. |
2719 | This variable works like fetcher | 2719 | This variable works like fetcher |
2720 | <filename>MIRRORS</filename>/<filename>PREMIRRORS</filename> | 2720 | <filename>MIRRORS</filename>/<filename>PREMIRRORS</filename> |
2721 | and points to the cache locations to check for the shared | 2721 | and points to the cache locations to check for the shared |
2722 | objects. | 2722 | objects. |
2723 | </para> | 2723 | </para> |
2724 | 2724 | ||
2725 | <para> | 2725 | <para> |
2726 | You can specify a filesystem directory or a remote URL such | 2726 | You can specify a filesystem directory or a remote URL such |
2727 | as HTTP or FTP. | 2727 | as HTTP or FTP. |
2728 | The locations you specify need to contain the shared state | 2728 | The locations you specify need to contain the shared state |
2729 | cache (sstate-cache) results from previous builds. | 2729 | cache (sstate-cache) results from previous builds. |
2730 | The sstate-cache you point to can also be from builds on | 2730 | The sstate-cache you point to can also be from builds on |
2731 | other machines. | 2731 | other machines. |
2732 | </para> | 2732 | </para> |
2733 | 2733 | ||
2734 | <para> | 2734 | <para> |
2735 | If a mirror uses the same structure as | 2735 | If a mirror uses the same structure as |
2736 | <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>, | 2736 | <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>, |
2737 | you need to add | 2737 | you need to add |
2738 | "PATH" at the end as shown in the examples below. | 2738 | "PATH" at the end as shown in the examples below. |
2739 | The build system substitues the correct path within the | 2739 | The build system substitues the correct path within the |
2740 | directory structure. | 2740 | directory structure. |
2741 | <literallayout class='monospaced'> | 2741 | <literallayout class='monospaced'> |
2742 | SSTATE_MIRRORS ?= "\ | 2742 | SSTATE_MIRRORS ?= "\ |
@@ -2761,14 +2761,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2761 | <para> | 2761 | <para> |
2762 | Specifies the base path used to create recipe stamp files. | 2762 | Specifies the base path used to create recipe stamp files. |
2763 | The path to an actual stamp file is constructed by evaluating this | 2763 | The path to an actual stamp file is constructed by evaluating this |
2764 | string and then appending additional information. | 2764 | string and then appending additional information. |
2765 | Currently, the default assignment for <filename>STAMP</filename> | 2765 | Currently, the default assignment for <filename>STAMP</filename> |
2766 | as set in the <filename>meta/conf/bitbake.conf</filename> file | 2766 | as set in the <filename>meta/conf/bitbake.conf</filename> file |
2767 | is: | 2767 | is: |
2768 | <literallayout class='monospaced'> | 2768 | <literallayout class='monospaced'> |
2769 | STAMP = "${TMPDIR}/stamps/${MULTIMACH_TARGET_SYS}/${PN}-${EXTENDPE}${PV}-${PR}" | 2769 | STAMP = "${TMPDIR}/stamps/${MULTIMACH_TARGET_SYS}/${PN}-${EXTENDPE}${PV}-${PR}" |
2770 | </literallayout> | 2770 | </literallayout> |
2771 | See <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>, | 2771 | See <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>, |
2772 | <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>, | 2772 | <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>, |
2773 | <link linkend='var-PN'><filename>PN</filename></link>, | 2773 | <link linkend='var-PN'><filename>PN</filename></link>, |
2774 | <link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>, | 2774 | <link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>, |
@@ -2781,12 +2781,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2781 | 2781 | ||
2782 | <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> | 2782 | <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> |
2783 | <glossdef> | 2783 | <glossdef> |
2784 | <para>The short (72 characters or less) summary of the binary package for packaging | 2784 | <para>The short (72 characters or less) summary of the binary package for packaging |
2785 | systems such as <filename>opkg</filename>, <filename>rpm</filename> or | 2785 | systems such as <filename>opkg</filename>, <filename>rpm</filename> or |
2786 | <filename>dpkg</filename>. | 2786 | <filename>dpkg</filename>. |
2787 | By default, <filename>SUMMARY</filename> is used to define | 2787 | By default, <filename>SUMMARY</filename> is used to define |
2788 | the <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link> | 2788 | the <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link> |
2789 | variable if <filename>DESCRIPTION</filename> is not set | 2789 | variable if <filename>DESCRIPTION</filename> is not set |
2790 | in the recipe. | 2790 | in the recipe. |
2791 | </para> | 2791 | </para> |
2792 | </glossdef> | 2792 | </glossdef> |
@@ -2798,18 +2798,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2798 | 2798 | ||
2799 | <glossentry id='var-T'><glossterm>T</glossterm> | 2799 | <glossentry id='var-T'><glossterm>T</glossterm> |
2800 | <glossdef> | 2800 | <glossdef> |
2801 | <para>This variable points to a directory were Bitbake places temporary | 2801 | <para>This variable points to a directory were Bitbake places temporary |
2802 | files when building a particular package. | 2802 | files when building a particular package. |
2803 | It is typically set as follows: | 2803 | It is typically set as follows: |
2804 | <literallayout class='monospaced'> | 2804 | <literallayout class='monospaced'> |
2805 | T = ${WORKDIR}/temp | 2805 | T = ${WORKDIR}/temp |
2806 | </literallayout> | 2806 | </literallayout> |
2807 | The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> | 2807 | The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> |
2808 | is the directory into which Bitbake unpacks and builds the package. | 2808 | is the directory into which Bitbake unpacks and builds the package. |
2809 | The default <filename>bitbake.conf</filename> file sets this variable.</para> | 2809 | The default <filename>bitbake.conf</filename> file sets this variable.</para> |
2810 | <para>The <filename>T</filename> variable is not to be confused with | 2810 | <para>The <filename>T</filename> variable is not to be confused with |
2811 | the <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> variable, | 2811 | the <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> variable, |
2812 | which points to the root of the directory tree where Bitbake | 2812 | which points to the root of the directory tree where Bitbake |
2813 | places the output of an entire build. | 2813 | places the output of an entire build. |
2814 | </para> | 2814 | </para> |
2815 | </glossdef> | 2815 | </glossdef> |
@@ -2817,7 +2817,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2817 | 2817 | ||
2818 | <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm> | 2818 | <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm> |
2819 | <glossdef> | 2819 | <glossdef> |
2820 | <para>The architecture of the device being built. | 2820 | <para>The architecture of the device being built. |
2821 | While a number of values are possible, the OpenEmbedded build system primarily supports | 2821 | While a number of values are possible, the OpenEmbedded build system primarily supports |
2822 | <filename>arm</filename> and <filename>i586</filename>.</para> | 2822 | <filename>arm</filename> and <filename>i586</filename>.</para> |
2823 | </glossdef> | 2823 | </glossdef> |
@@ -2826,8 +2826,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2826 | <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm> | 2826 | <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm> |
2827 | <glossdef> | 2827 | <glossdef> |
2828 | <para> | 2828 | <para> |
2829 | Flags passed to the C compiler for the target system. | 2829 | Flags passed to the C compiler for the target system. |
2830 | This variable evaluates to the same as | 2830 | This variable evaluates to the same as |
2831 | <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>. | 2831 | <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>. |
2832 | </para> | 2832 | </para> |
2833 | </glossdef> | 2833 | </glossdef> |
@@ -2836,7 +2836,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2836 | 2836 | ||
2837 | <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm> | 2837 | <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm> |
2838 | <glossdef> | 2838 | <glossdef> |
2839 | <para>Specifies the method for handling FPU code. | 2839 | <para>Specifies the method for handling FPU code. |
2840 | For FPU-less targets, which include most ARM CPUs, the variable must be | 2840 | For FPU-less targets, which include most ARM CPUs, the variable must be |
2841 | set to "soft". | 2841 | set to "soft". |
2842 | If not, the kernel emulation gets used, which results in a performance penalty.</para> | 2842 | If not, the kernel emulation gets used, which results in a performance penalty.</para> |
@@ -2845,9 +2845,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2845 | 2845 | ||
2846 | <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm> | 2846 | <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm> |
2847 | <glossdef> | 2847 | <glossdef> |
2848 | <para>Specifies the target's operating system. | 2848 | <para>Specifies the target's operating system. |
2849 | The variable can be set to "linux" for <filename>eglibc</filename>-based systems and | 2849 | The variable can be set to "linux" for <filename>eglibc</filename>-based systems and |
2850 | to "linux-uclibc" for <filename>uclibc</filename>. | 2850 | to "linux-uclibc" for <filename>uclibc</filename>. |
2851 | For ARM/EABI targets, there are also "linux-gnueabi" and | 2851 | For ARM/EABI targets, there are also "linux-gnueabi" and |
2852 | "linux-uclibc-gnueabi" values possible.</para> | 2852 | "linux-uclibc-gnueabi" values possible.</para> |
2853 | </glossdef> | 2853 | </glossdef> |
@@ -2864,7 +2864,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2864 | <para> | 2864 | <para> |
2865 | You can select <filename>eglibc</filename> or <filename>uclibc</filename>. | 2865 | You can select <filename>eglibc</filename> or <filename>uclibc</filename>. |
2866 | <note> | 2866 | <note> |
2867 | This release of the Yocto Project does not support the | 2867 | This release of the Yocto Project does not support the |
2868 | <filename>glibc</filename> implementation of <filename>libc</filename>. | 2868 | <filename>glibc</filename> implementation of <filename>libc</filename>. |
2869 | </note> | 2869 | </note> |
2870 | </para> | 2870 | </para> |
@@ -2874,7 +2874,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2874 | <glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm> | 2874 | <glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm> |
2875 | <glossdef> | 2875 | <glossdef> |
2876 | <para> | 2876 | <para> |
2877 | The toolchain selector. | 2877 | The toolchain selector. |
2878 | This variable replaces <filename>POKYMODE</filename>, which is no longer | 2878 | This variable replaces <filename>POKYMODE</filename>, which is no longer |
2879 | supported. | 2879 | supported. |
2880 | </para> | 2880 | </para> |
@@ -2882,39 +2882,39 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2882 | The <filename>TCMODE</filename> variable selects the external toolchain | 2882 | The <filename>TCMODE</filename> variable selects the external toolchain |
2883 | built using the OpenEmbedded build system or a few supported combinations of | 2883 | built using the OpenEmbedded build system or a few supported combinations of |
2884 | the upstream GCC or CodeSourcery Labs toolchain. | 2884 | the upstream GCC or CodeSourcery Labs toolchain. |
2885 | The variable identifies the <filename>tcmode-*</filename> files used in | 2885 | The variable identifies the <filename>tcmode-*</filename> files used in |
2886 | the <filename>meta/conf/distro/include</filename> directory, which is found in the | 2886 | the <filename>meta/conf/distro/include</filename> directory, which is found in the |
2887 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 2887 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
2888 | </para> | 2888 | </para> |
2889 | <para> | 2889 | <para> |
2890 | By default, <filename>TCMODE</filename> is set to "default", which | 2890 | By default, <filename>TCMODE</filename> is set to "default", which |
2891 | chooses the <filename>tcmode-default.inc</filename> file. | 2891 | chooses the <filename>tcmode-default.inc</filename> file. |
2892 | The variable is similar to | 2892 | The variable is similar to |
2893 | <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, which controls | 2893 | <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, which controls |
2894 | the variant of the GNU standard C library (<filename>libc</filename>) | 2894 | the variant of the GNU standard C library (<filename>libc</filename>) |
2895 | used during the build process: <filename>eglibc</filename> or <filename>uclibc</filename>. | 2895 | used during the build process: <filename>eglibc</filename> or <filename>uclibc</filename>. |
2896 | </para> | 2896 | </para> |
2897 | </glossdef> | 2897 | </glossdef> |
2898 | </glossentry> | 2898 | </glossentry> |
2899 | 2899 | ||
2900 | <glossentry id='var-TMPDIR'><glossterm>TMPDIR</glossterm> | 2900 | <glossentry id='var-TMPDIR'><glossterm>TMPDIR</glossterm> |
2901 | <glossdef> | 2901 | <glossdef> |
2902 | <para> | 2902 | <para> |
2903 | This variable is the temporary directory the OpenEmbedded build system | 2903 | This variable is the temporary directory the OpenEmbedded build system |
2904 | uses when it does its work building images. | 2904 | uses when it does its work building images. |
2905 | By default, the <filename>TMPDIR</filename> variable is named | 2905 | By default, the <filename>TMPDIR</filename> variable is named |
2906 | <filename>tmp</filename> within the | 2906 | <filename>tmp</filename> within the |
2907 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 2907 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
2908 | </para> | 2908 | </para> |
2909 | 2909 | ||
2910 | <para> | 2910 | <para> |
2911 | If you want to establish this directory in a location other than the | 2911 | If you want to establish this directory in a location other than the |
2912 | default, you can uncomment the following statement in the | 2912 | default, you can uncomment the following statement in the |
2913 | <filename>conf/local.conf</filename> file in the | 2913 | <filename>conf/local.conf</filename> file in the |
2914 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: | 2914 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: |
2915 | <literallayout class='monospaced'> | 2915 | <literallayout class='monospaced'> |
2916 | #TMPDIR = "${TOPDIR}/tmp" | 2916 | #TMPDIR = "${TOPDIR}/tmp" |
2917 | </literallayout> | 2917 | </literallayout> |
2918 | </para> | 2918 | </para> |
2919 | </glossdef> | 2919 | </glossdef> |
2920 | </glossentry> | 2920 | </glossentry> |
@@ -2922,10 +2922,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2922 | <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm> | 2922 | <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm> |
2923 | <glossdef> | 2923 | <glossdef> |
2924 | <para> | 2924 | <para> |
2925 | This variable is the | 2925 | This variable is the |
2926 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 2926 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
2927 | BitBake automatically sets this variable. | 2927 | BitBake automatically sets this variable. |
2928 | The OpenEmbedded build system uses the Build Directory when building images. | 2928 | The OpenEmbedded build system uses the Build Directory when building images. |
2929 | </para> | 2929 | </para> |
2930 | </glossdef> | 2930 | </glossdef> |
2931 | </glossentry> | 2931 | </glossentry> |
@@ -2943,7 +2943,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2943 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> | 2943 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> |
2944 | <glossdef> | 2944 | <glossdef> |
2945 | <para> | 2945 | <para> |
2946 | The pathname of the working directory in which the OpenEmbedded build system | 2946 | The pathname of the working directory in which the OpenEmbedded build system |
2947 | builds a recipe. | 2947 | builds a recipe. |
2948 | This directory is located within the | 2948 | This directory is located within the |
2949 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes | 2949 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes |
@@ -2964,17 +2964,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2964 | </para> | 2964 | </para> |
2965 | 2965 | ||
2966 | <para> | 2966 | <para> |
2967 | For packages that are not dependent on a particular machine, | 2967 | For packages that are not dependent on a particular machine, |
2968 | <filename>WORKDIR</filename> is defined as follows: | 2968 | <filename>WORKDIR</filename> is defined as follows: |
2969 | <literallayout class='monospaced'> | 2969 | <literallayout class='monospaced'> |
2970 | ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} | 2970 | ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} |
2971 | </literallayout> | 2971 | </literallayout> |
2972 | As an example, assume a | 2972 | As an example, assume a |
2973 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level | 2973 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level |
2974 | folder name <filename>poky</filename> and a default | 2974 | folder name <filename>poky</filename> and a default |
2975 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 2975 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
2976 | at <filename>poky/build</filename>. | 2976 | at <filename>poky/build</filename>. |
2977 | In this case, the working directory the build system uses to build | 2977 | In this case, the working directory the build system uses to build |
2978 | the <filename>v86d</filename> package is the following: | 2978 | the <filename>v86d</filename> package is the following: |
2979 | <literallayout class='monospaced'> | 2979 | <literallayout class='monospaced'> |
2980 | ~/poky/build/tmp/work/qemux86-poky-linux/v86d-01.9-r0 | 2980 | ~/poky/build/tmp/work/qemux86-poky-linux/v86d-01.9-r0 |
@@ -2987,11 +2987,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2987 | <literallayout class='monospaced'> | 2987 | <literallayout class='monospaced'> |
2988 | ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} | 2988 | ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} |
2989 | </literallayout> | 2989 | </literallayout> |
2990 | As an example, again assume a Source Directory top-level folder | 2990 | As an example, again assume a Source Directory top-level folder |
2991 | named <filename>poky</filename> and a default Build Directory | 2991 | named <filename>poky</filename> and a default Build Directory |
2992 | at <filename>poky/build</filename>. | 2992 | at <filename>poky/build</filename>. |
2993 | In this case, the working directory the build system uses to build | 2993 | In this case, the working directory the build system uses to build |
2994 | the <filename>acl</filename> recipe, which is being built for a | 2994 | the <filename>acl</filename> recipe, which is being built for a |
2995 | MIPS-based device, is the following: | 2995 | MIPS-based device, is the following: |
2996 | <literallayout class='monospaced'> | 2996 | <literallayout class='monospaced'> |
2997 | ~/poky/build/tmp/work/mips-poky-linux/acl-2.2.51-r2 | 2997 | ~/poky/build/tmp/work/mips-poky-linux/acl-2.2.51-r2 |
@@ -3013,6 +3013,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
3013 | 3013 | ||
3014 | </glossary> | 3014 | </glossary> |
3015 | </chapter> | 3015 | </chapter> |
3016 | <!-- | 3016 | <!-- |
3017 | vim: expandtab tw=80 ts=4 | 3017 | vim: expandtab tw=80 ts=4 |
3018 | --> | 3018 | --> |