diff options
Diffstat (limited to 'handbook/ref-variables.xml')
-rw-r--r-- | handbook/ref-variables.xml | 825 |
1 files changed, 825 insertions, 0 deletions
diff --git a/handbook/ref-variables.xml b/handbook/ref-variables.xml new file mode 100644 index 0000000000..437e8240f6 --- /dev/null +++ b/handbook/ref-variables.xml | |||
@@ -0,0 +1,825 @@ | |||
1 | <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
3 | |||
4 | <!-- Dummy chapter --> | ||
5 | <appendix id='ref-variables-glos'> | ||
6 | |||
7 | <title>Reference: Variables Glossary</title> | ||
8 | |||
9 | <para> | ||
10 | This section lists common variables used in Poky and gives an overview | ||
11 | of their function and contents. | ||
12 | </para> | ||
13 | |||
14 | <glossary id='ref-variables-glossary'> | ||
15 | |||
16 | |||
17 | <para> | ||
18 | <link linkend='var-glossary-a'>A</link> | ||
19 | <link linkend='var-glossary-b'>B</link> | ||
20 | <link linkend='var-glossary-c'>C</link> | ||
21 | <link linkend='var-glossary-d'>D</link> | ||
22 | <link linkend='var-glossary-e'>E</link> | ||
23 | <link linkend='var-glossary-f'>F</link> | ||
24 | <!-- <link linkend='var-glossary-g'>G</link> --> | ||
25 | <link linkend='var-glossary-h'>H</link> | ||
26 | <link linkend='var-glossary-i'>I</link> | ||
27 | <!-- <link linkend='var-glossary-j'>J</link> --> | ||
28 | <link linkend='var-glossary-k'>K</link> | ||
29 | <link linkend='var-glossary-l'>L</link> | ||
30 | <link linkend='var-glossary-m'>M</link> | ||
31 | <!-- <link linkend='var-glossary-n'>N</link> --> | ||
32 | <!-- <link linkend='var-glossary-o'>O</link> --> | ||
33 | <link linkend='var-glossary-p'>P</link> | ||
34 | <!-- <link linkend='var-glossary-q'>Q</link> --> | ||
35 | <link linkend='var-glossary-r'>R</link> | ||
36 | <link linkend='var-glossary-s'>S</link> | ||
37 | <link linkend='var-glossary-t'>T</link> | ||
38 | <!-- <link linkend='var-glossary-u'>U</link> --> | ||
39 | <!-- <link linkend='var-glossary-v'>V</link> --> | ||
40 | <link linkend='var-glossary-w'>W</link> | ||
41 | <!-- <link linkend='var-glossary-x'>X</link> --> | ||
42 | <!-- <link linkend='var-glossary-y'>Y</link> --> | ||
43 | <!-- <link linkend='var-glossary-z'>Z</link>--> | ||
44 | </para> | ||
45 | |||
46 | <glossdiv id='var-glossary-a'><title>A</title> | ||
47 | |||
48 | <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> | ||
49 | <glossdef> | ||
50 | <para>E-mail address to contact original author(s) - to | ||
51 | send patches, forward bugs...</para> | ||
52 | </glossdef> | ||
53 | </glossentry> | ||
54 | |||
55 | <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm> | ||
56 | <glossdef> | ||
57 | <para>Use current (newest) source revision - used with | ||
58 | <glossterm><link linkend='var-SRCREV'>SRCREV</link></glossterm> | ||
59 | variable.</para> | ||
60 | </glossdef> | ||
61 | </glossentry> | ||
62 | |||
63 | </glossdiv> | ||
64 | |||
65 | <glossdiv id='var-glossary-b'><title>B</title> | ||
66 | |||
67 | <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> | ||
68 | <glossdef> | ||
69 | <para>Number of BitBake threads</para> | ||
70 | </glossdef> | ||
71 | </glossentry> | ||
72 | |||
73 | <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm> | ||
74 | <glossdef> | ||
75 | <para>List of recipes used by BitBake to build software</para> | ||
76 | </glossdef> | ||
77 | </glossentry> | ||
78 | |||
79 | <!-- BBPATH is not a usable variable in .bb files and should not be listed here --> | ||
80 | |||
81 | <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm> | ||
82 | <glossdef> | ||
83 | <para>Variable which controls how BitBake displays logs on build failure.</para> | ||
84 | </glossdef> | ||
85 | </glossentry> | ||
86 | |||
87 | </glossdiv> | ||
88 | |||
89 | <glossdiv id='var-glossary-c'><title>C</title> | ||
90 | |||
91 | <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm> | ||
92 | <glossdef> | ||
93 | <para> | ||
94 | Flags passed to C compiler for the target system. Evaluates to the same | ||
95 | as <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>. | ||
96 | </para> | ||
97 | </glossdef> | ||
98 | </glossentry> | ||
99 | |||
100 | <glossentry id='var-COMPATIBLE_MACHINES'><glossterm>COMPATIBLE_MACHINES</glossterm> | ||
101 | <glossdef> | ||
102 | <para>A regular expression which evalutates to match the machines the recipe | ||
103 | works with. It stops recipes being run on machines they're incompatible with | ||
104 | which is partciuarly useful with kernels. It also helps to to increase parsing | ||
105 | speed as if its found the current machine is not compatible, further parsing | ||
106 | of the recipe is skipped.</para> | ||
107 | </glossdef> | ||
108 | </glossentry> | ||
109 | |||
110 | <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> | ||
111 | <glossdef> | ||
112 | <para> | ||
113 | Contains a list of files which containing autoconf test results relevant | ||
114 | to the current build. This variable is used by the autotools utilities | ||
115 | when running configure. | ||
116 | </para> | ||
117 | </glossdef> | ||
118 | </glossentry> | ||
119 | |||
120 | |||
121 | <glossentry id='var-CVS_TARBALL_STASH'><glossterm>CVS_TARBALL_STASH</glossterm> | ||
122 | <glossdef> | ||
123 | <para>Location to search for | ||
124 | pre-generated tarballs when fetching from remote SCM | ||
125 | repositories (CVS/SVN/GIT)</para> | ||
126 | </glossdef> | ||
127 | </glossentry> | ||
128 | |||
129 | </glossdiv> | ||
130 | |||
131 | <glossdiv id='var-glossary-d'><title>D</title> | ||
132 | |||
133 | <glossentry id='var-D'><glossterm>D</glossterm> | ||
134 | <glossdef> | ||
135 | <para>Destination directory</para> | ||
136 | </glossdef> | ||
137 | </glossentry> | ||
138 | |||
139 | <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm> | ||
140 | <glossdef> | ||
141 | <para> | ||
142 | Build packages with debugging information. This influences the value | ||
143 | <link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link> | ||
144 | takes. | ||
145 | </para> | ||
146 | </glossdef> | ||
147 | </glossentry> | ||
148 | |||
149 | <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm> | ||
150 | <glossdef> | ||
151 | <para> | ||
152 | The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link> | ||
153 | and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling a system for debugging. | ||
154 | This defaults to "-O -fno-omit-frame-pointer -g". | ||
155 | </para> | ||
156 | </glossdef> | ||
157 | </glossentry> | ||
158 | |||
159 | <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm> | ||
160 | <glossdef> | ||
161 | <para>Priority of recipe</para> | ||
162 | </glossdef> | ||
163 | </glossentry> | ||
164 | |||
165 | <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm> | ||
166 | <glossdef> | ||
167 | <para> | ||
168 | A list of build time dependencies for a given recipe. These indicate | ||
169 | recipes that must have staged before this recipe can configure. | ||
170 | </para> | ||
171 | </glossdef> | ||
172 | </glossentry> | ||
173 | |||
174 | <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> | ||
175 | <glossdef> | ||
176 | <para>Package description used by package | ||
177 | managers</para> | ||
178 | </glossdef> | ||
179 | </glossentry> | ||
180 | |||
181 | <glossentry id='var-DESTDIR'><glossterm>DESTDIR</glossterm> | ||
182 | <glossdef> | ||
183 | <para>Destination directory</para> | ||
184 | </glossdef> | ||
185 | </glossentry> | ||
186 | |||
187 | <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm> | ||
188 | <glossdef> | ||
189 | <para>Short name of distribution</para> | ||
190 | </glossdef> | ||
191 | </glossentry> | ||
192 | |||
193 | <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm> | ||
194 | <glossdef> | ||
195 | <para>List of packages required by distribution.</para> | ||
196 | </glossdef> | ||
197 | </glossentry> | ||
198 | |||
199 | <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm> | ||
200 | <glossdef> | ||
201 | <para>List of packages which extend usability of | ||
202 | image. Those packages will be automatically | ||
203 | installed but can be removed by user.</para> | ||
204 | </glossdef> | ||
205 | </glossentry> | ||
206 | |||
207 | <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm> | ||
208 | <glossdef> | ||
209 | <para>Features of the distribution.</para> | ||
210 | </glossdef> | ||
211 | </glossentry> | ||
212 | |||
213 | <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm> | ||
214 | <glossdef> | ||
215 | <para>Long name of distribution</para> | ||
216 | </glossdef> | ||
217 | </glossentry> | ||
218 | |||
219 | <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm> | ||
220 | <glossdef> | ||
221 | <para>Version of distribution</para> | ||
222 | </glossdef> | ||
223 | </glossentry> | ||
224 | |||
225 | <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> | ||
226 | <glossdef> | ||
227 | <para>Directory where all fetched sources will be stored</para> | ||
228 | </glossdef> | ||
229 | |||
230 | </glossentry> | ||
231 | </glossdiv> | ||
232 | |||
233 | <glossdiv id='var-glossary-e'><title>E</title> | ||
234 | |||
235 | <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm> | ||
236 | <glossdef> | ||
237 | <para>Variable which control which locales for glibc are | ||
238 | to be generated during build (useful if target device | ||
239 | has 64M RAM or less)</para> | ||
240 | </glossdef> | ||
241 | </glossentry> | ||
242 | |||
243 | <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm> | ||
244 | <glossdef> | ||
245 | <para>Additional 'configure' script options</para> | ||
246 | </glossdef> | ||
247 | </glossentry> | ||
248 | |||
249 | <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm> | ||
250 | <glossdef> | ||
251 | <para>Additional GNU make options</para> | ||
252 | </glossdef> | ||
253 | </glossentry> | ||
254 | |||
255 | </glossdiv> | ||
256 | |||
257 | <glossdiv id='var-glossary-f'><title>F</title> | ||
258 | |||
259 | <glossentry id='var-FILES'><glossterm>FILES</glossterm> | ||
260 | <glossdef> | ||
261 | <para>list of directories/files which will be placed | ||
262 | in packages</para> | ||
263 | </glossdef> | ||
264 | </glossentry> | ||
265 | |||
266 | <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm> | ||
267 | <glossdef> | ||
268 | <para> | ||
269 | The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link> | ||
270 | and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling an optimised system. | ||
271 | This defaults to "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2". | ||
272 | </para> | ||
273 | </glossdef> | ||
274 | </glossentry> | ||
275 | |||
276 | </glossdiv> | ||
277 | |||
278 | <!-- <glossdiv id='var-glossary-g'><title>G</title>--> | ||
279 | <!-- </glossdiv>--> | ||
280 | |||
281 | <glossdiv id='var-glossary-h'><title>H</title> | ||
282 | |||
283 | <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm> | ||
284 | <glossdef> | ||
285 | <para>Website where more info about package can be found</para> | ||
286 | </glossdef> | ||
287 | </glossentry> | ||
288 | |||
289 | </glossdiv> | ||
290 | |||
291 | <glossdiv id='var-glossary-i'><title>I</title> | ||
292 | |||
293 | <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm> | ||
294 | <glossdef> | ||
295 | <para><link linkend="ref-features-image">List of | ||
296 | features</link> present in resulting images</para> | ||
297 | </glossdef> | ||
298 | </glossentry> | ||
299 | |||
300 | <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm> | ||
301 | <glossdef> | ||
302 | <para>Formats of rootfs images which we want to have | ||
303 | created</para> | ||
304 | </glossdef> | ||
305 | </glossentry> | ||
306 | |||
307 | <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm> | ||
308 | <glossdef> | ||
309 | <para>List of packages used to build image</para> | ||
310 | </glossdef> | ||
311 | </glossentry> | ||
312 | |||
313 | <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm> | ||
314 | <glossdef> | ||
315 | <para> | ||
316 | This variable causes the build to not strip binaries in | ||
317 | resulting packages. | ||
318 | </para> | ||
319 | </glossdef> | ||
320 | </glossentry> | ||
321 | |||
322 | |||
323 | <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> | ||
324 | <glossdef> | ||
325 | <para> | ||
326 | This variable causes the named class to be inherited at | ||
327 | this point during parsing. Its only valid in configuration | ||
328 | files. | ||
329 | </para> | ||
330 | </glossdef> | ||
331 | </glossentry> | ||
332 | |||
333 | |||
334 | <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm> | ||
335 | <glossdef> | ||
336 | <para> | ||
337 | Scope: Used in recipes when using update-rc.d.bbclass. Optional, defaults to PN. | ||
338 | </para> | ||
339 | <para> | ||
340 | A list of the packages which contain initscripts. If multiple | ||
341 | packages are specified you need to append the package name | ||
342 | to the other INITSCRIPT_* as an override. | ||
343 | </para> | ||
344 | </glossdef> | ||
345 | </glossentry> | ||
346 | |||
347 | <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm> | ||
348 | <glossdef> | ||
349 | <para> | ||
350 | Scope: Used in recipes when using update-rc.d.bbclass. Mandatory. | ||
351 | </para> | ||
352 | <para> | ||
353 | The filename of the initscript (as installed to ${etcdir}/init.d). | ||
354 | </para> | ||
355 | </glossdef> | ||
356 | </glossentry> | ||
357 | |||
358 | <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm> | ||
359 | <glossdef> | ||
360 | <para> | ||
361 | Scope: Used in recipes when using update-rc.d.bbclass. Mandatory. | ||
362 | </para> | ||
363 | <para> | ||
364 | Specifies the options to pass to update-rc.d. An example is | ||
365 | "start 99 5 2 . stop 20 0 1 6 ." which gives the script a | ||
366 | runlevel of 99, starts the script in initlevels 2 and 5 and | ||
367 | stops it in levels 0, 1 and 6. | ||
368 | </para> | ||
369 | </glossdef> | ||
370 | </glossentry> | ||
371 | |||
372 | |||
373 | </glossdiv> | ||
374 | |||
375 | <!-- <glossdiv id='var-glossary-j'><title>J</title>--> | ||
376 | <!-- </glossdiv>--> | ||
377 | |||
378 | <glossdiv id='var-glossary-k'><title>K</title> | ||
379 | |||
380 | <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> | ||
381 | <glossdef> | ||
382 | <para>The type of kernel to build for a device, usually set by the | ||
383 | machine configuration files and defaults to "zImage". This is used | ||
384 | when building the kernel and is passed to "make" as the target to | ||
385 | build.</para> | ||
386 | </glossdef> | ||
387 | </glossentry> | ||
388 | |||
389 | </glossdiv> | ||
390 | |||
391 | <glossdiv id='var-glossary-l'><title>L</title> | ||
392 | |||
393 | <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm> | ||
394 | <glossdef> | ||
395 | <para>List of package source licenses.</para> | ||
396 | </glossdef> | ||
397 | </glossentry> | ||
398 | |||
399 | </glossdiv> | ||
400 | |||
401 | <glossdiv id='var-glossary-m'><title>M</title> | ||
402 | |||
403 | <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm> | ||
404 | <glossdef> | ||
405 | <para>Target device</para> | ||
406 | </glossdef> | ||
407 | </glossentry> | ||
408 | |||
409 | <glossentry id='var-MACHINE_ESSENTIAL_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_RDEPENDS</glossterm> | ||
410 | <glossdef> | ||
411 | <para>List of packages required to boot device</para> | ||
412 | </glossdef> | ||
413 | </glossentry> | ||
414 | |||
415 | <glossentry id='var-MACHINE_ESSENTIAL_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_RRECOOMENDS</glossterm> | ||
416 | <glossdef> | ||
417 | <para>List of packages required to boot device (usually | ||
418 | additional kernel modules)</para> | ||
419 | </glossdef> | ||
420 | </glossentry> | ||
421 | |||
422 | <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm> | ||
423 | <glossdef> | ||
424 | <para>List of packages required to use device</para> | ||
425 | </glossdef> | ||
426 | </glossentry> | ||
427 | |||
428 | <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMNEDS</glossterm> | ||
429 | <glossdef> | ||
430 | <para>List of packages useful to use device (for example | ||
431 | additional kernel modules)</para> | ||
432 | </glossdef> | ||
433 | </glossentry> | ||
434 | |||
435 | <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> | ||
436 | <glossdef> | ||
437 | <para>List of device features - defined in <link | ||
438 | linkend='ref-features-machine'>machine | ||
439 | features section</link></para> | ||
440 | </glossdef> | ||
441 | </glossentry> | ||
442 | |||
443 | <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm> | ||
444 | <glossdef> | ||
445 | <para>E-mail of distribution maintainer</para> | ||
446 | </glossdef> | ||
447 | </glossentry> | ||
448 | </glossdiv> | ||
449 | |||
450 | <!-- <glossdiv id='var-glossary-n'><title>N</title>--> | ||
451 | <!-- </glossdiv>--> | ||
452 | |||
453 | <!-- <glossdiv id='var-glossary-o'><title>O</title>--> | ||
454 | <!-- </glossdiv>--> | ||
455 | |||
456 | <glossdiv id='var-glossary-p'><title>P</title> | ||
457 | |||
458 | <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm> | ||
459 | <glossdef> | ||
460 | <para>Architecture of resulting package</para> | ||
461 | </glossdef> | ||
462 | </glossentry> | ||
463 | |||
464 | <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm> | ||
465 | <glossdef> | ||
466 | <para>List of resulting packages formats</para> | ||
467 | </glossdef> | ||
468 | </glossentry> | ||
469 | |||
470 | <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm> | ||
471 | <glossdef> | ||
472 | <para>List of architectures compatible with device | ||
473 | CPU. Usable when build is done for few different | ||
474 | devices with misc processors (like XScale and | ||
475 | ARM926-EJS)</para> | ||
476 | </glossdef> | ||
477 | </glossentry> | ||
478 | |||
479 | <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> | ||
480 | <glossdef> | ||
481 | <para>List of packages to be created from recipe. | ||
482 | The default value is "${PN}-dbg ${PN} ${PN}-doc ${PN}-dev"</para> | ||
483 | </glossdef> | ||
484 | </glossentry> | ||
485 | |||
486 | <glossentry id='var-PN'><glossterm>PN</glossterm> | ||
487 | <glossdef> | ||
488 | <para>Name of package. | ||
489 | </para> | ||
490 | </glossdef> | ||
491 | </glossentry> | ||
492 | |||
493 | <glossentry id='var-PR'><glossterm>PR</glossterm> | ||
494 | <glossdef> | ||
495 | <para>Revision of package. | ||
496 | </para> | ||
497 | </glossdef> | ||
498 | </glossentry> | ||
499 | |||
500 | <glossentry id='var-PV'><glossterm>PV</glossterm> | ||
501 | <glossdef> | ||
502 | <para>Version of package. | ||
503 | The default value is "1.0"</para> | ||
504 | </glossdef> | ||
505 | </glossentry> | ||
506 | |||
507 | <glossentry id='var-PE'><glossterm>PE</glossterm> | ||
508 | <glossdef> | ||
509 | <para> | ||
510 | Epoch of the package. The default value is "1". The field is used | ||
511 | to make upgrades possible when the versioning scheme changes in | ||
512 | some backwards incompatible way. | ||
513 | </para> | ||
514 | </glossdef> | ||
515 | </glossentry> | ||
516 | |||
517 | <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm> | ||
518 | <glossdef> | ||
519 | <para>If multiple recipes provide an item, this variable | ||
520 | determines which one should be given preference. It | ||
521 | should be set to the "$PN" of the recipe to be preferred.</para> | ||
522 | </glossdef> | ||
523 | </glossentry> | ||
524 | |||
525 | <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm> | ||
526 | <glossdef> | ||
527 | <para> | ||
528 | If there are multiple versions of recipe available, this | ||
529 | variable determines which one should be given preference. It | ||
530 | should be set to the "$PV" of the recipe to be preferred. | ||
531 | </para> | ||
532 | </glossdef> | ||
533 | </glossentry> | ||
534 | |||
535 | <glossentry id='var-POKYLIBC'><glossterm>POKYLIBC</glossterm> | ||
536 | <glossdef> | ||
537 | <para>Libc implementation selector - glibc or uclibc can be selected.</para> | ||
538 | </glossdef> | ||
539 | </glossentry> | ||
540 | |||
541 | <glossentry id='var-POKYMODE'><glossterm>POKYMODE</glossterm> | ||
542 | <glossdef> | ||
543 | <para>Toolchain selector. It can be external toolchain | ||
544 | built from Poky or few supported combinations of | ||
545 | upstream GCC or CodeSourcery Labs toolchain.</para> | ||
546 | </glossdef> | ||
547 | </glossentry> | ||
548 | |||
549 | </glossdiv> | ||
550 | |||
551 | <!-- <glossdiv id='var-glossary-q'><title>Q</title>--> | ||
552 | <!-- </glossdiv>--> | ||
553 | |||
554 | <glossdiv id='var-glossary-r'><title>R</title> | ||
555 | |||
556 | <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm> | ||
557 | <glossdef> | ||
558 | <para>List of packages which which conflict with this | ||
559 | one. Package will not be installed if they will not | ||
560 | be removed first.</para> | ||
561 | </glossdef> | ||
562 | </glossentry> | ||
563 | |||
564 | <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm> | ||
565 | <glossdef> | ||
566 | <para> | ||
567 | A list of run-time dependencies for a package. These packages | ||
568 | need to be installed alongside the package it applies to so | ||
569 | the package will run correctly, an example is a perl script | ||
570 | which would rdepend on perl. Since this variable applies to | ||
571 | output packages there would usually be an override attached | ||
572 | to this variable like RDEPENDS_${PN}-dev. Names in this field | ||
573 | should be as they are in <link linkend='var-PACKAGES'>PACKAGES | ||
574 | </link> namespave before any renaming of the output package | ||
575 | by classes like debian.bbclass. | ||
576 | </para> | ||
577 | </glossdef> | ||
578 | </glossentry> | ||
579 | |||
580 | <glossentry id='var-ROOT_FLASH_SIZE'><glossterm>ROOT_FLASH_SIZE</glossterm> | ||
581 | <glossdef> | ||
582 | <para>Size of rootfs in megabytes</para> | ||
583 | </glossdef> | ||
584 | </glossentry> | ||
585 | |||
586 | <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm> | ||
587 | <glossdef> | ||
588 | <para>List of packages which extend usability of | ||
589 | package. Those packages will be automatically | ||
590 | installed but can be removed by user.</para> | ||
591 | </glossdef> | ||
592 | </glossentry> | ||
593 | |||
594 | <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm> | ||
595 | <glossdef> | ||
596 | <para>List of packages which are replaced with this | ||
597 | one.</para> | ||
598 | </glossdef> | ||
599 | </glossentry> | ||
600 | |||
601 | </glossdiv> | ||
602 | |||
603 | <glossdiv id='var-glossary-s'><title>S</title> | ||
604 | |||
605 | <glossentry id='var-S'><glossterm>S</glossterm> | ||
606 | <glossdef> | ||
607 | <para> | ||
608 | Path to unpacked sources (by default: | ||
609 | "${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}") | ||
610 | </para> | ||
611 | </glossdef> | ||
612 | </glossentry> | ||
613 | |||
614 | <glossentry id='var-SECTION'><glossterm>SECTION</glossterm> | ||
615 | <glossdef> | ||
616 | <para>Section where package should be put - used | ||
617 | by package managers</para> | ||
618 | </glossdef> | ||
619 | </glossentry> | ||
620 | |||
621 | <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm> | ||
622 | <glossdef> | ||
623 | <para> | ||
624 | The variable takes the value of <link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link> | ||
625 | unless <link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link> = "1" in which case | ||
626 | <link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link> is used. | ||
627 | </para> | ||
628 | </glossdef> | ||
629 | </glossentry> | ||
630 | |||
631 | |||
632 | <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm> | ||
633 | <glossdef> | ||
634 | <para>Speed and device for serial port used to attach | ||
635 | serial console. This is given to kernel as "console" | ||
636 | param and after boot getty is started on that port | ||
637 | so remote login is possible.</para> | ||
638 | </glossdef> | ||
639 | </glossentry> | ||
640 | |||
641 | <glossentry id='var-SHELLCMDS'><glossterm>SHELLCMDS</glossterm> | ||
642 | <glossdef> | ||
643 | <para> | ||
644 | A list of commands to run within the a shell, used by <glossterm><link | ||
645 | linkend='var-TERMCMDRUN'>TERMCMDRUN</link></glossterm>. It defaults to | ||
646 | <glossterm><link linkend='var-SHELLRCCMD'>SHELLRCCMD</link></glossterm>. | ||
647 | </para> | ||
648 | </glossdef> | ||
649 | </glossentry> | ||
650 | |||
651 | <glossentry id='var-SHELLRCCMD'><glossterm>SHELLRCCMD</glossterm> | ||
652 | <glossdef> | ||
653 | <para> | ||
654 | How to launch a shell, defaults to bash. | ||
655 | </para> | ||
656 | </glossdef> | ||
657 | </glossentry> | ||
658 | |||
659 | <glossentry id='var-SITEINFO_ENDIANESS'><glossterm>SITEINFO_ENDIANESS</glossterm> | ||
660 | <glossdef> | ||
661 | <para> | ||
662 | Contains "le" for little-endian or "be" for big-endian depending | ||
663 | on the endian byte order of the target system. | ||
664 | </para> | ||
665 | </glossdef> | ||
666 | </glossentry> | ||
667 | |||
668 | <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm> | ||
669 | <glossdef> | ||
670 | <para> | ||
671 | Contains "32" or "64" depending on the number of bits for the | ||
672 | CPU of the target system. | ||
673 | </para> | ||
674 | </glossdef> | ||
675 | </glossentry> | ||
676 | |||
677 | <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> | ||
678 | <glossdef> | ||
679 | <para>List of source files (local or remote ones)</para> | ||
680 | </glossdef> | ||
681 | </glossentry> | ||
682 | |||
683 | <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm> | ||
684 | <glossdef> | ||
685 | <para> | ||
686 | By default there is code which automatically detects whether | ||
687 | <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm> | ||
688 | contains files which are machine specific and if this is the case it | ||
689 | automatically changes | ||
690 | <glossterm><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></glossterm>. | ||
691 | Setting this variable to "0" disables that behaviour. | ||
692 | </para> | ||
693 | </glossdef> | ||
694 | </glossentry> | ||
695 | |||
696 | <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm> | ||
697 | <glossdef> | ||
698 | <para> | ||
699 | Date of source code used to build package (if it was fetched | ||
700 | from SCM). | ||
701 | </para> | ||
702 | </glossdef> | ||
703 | </glossentry> | ||
704 | |||
705 | <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm> | ||
706 | <glossdef> | ||
707 | <para> | ||
708 | Revision of source code used to build package (Subversion, | ||
709 | GIT, Bazaar only). | ||
710 | </para> | ||
711 | </glossdef> | ||
712 | </glossentry> | ||
713 | |||
714 | <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> | ||
715 | <glossdef> | ||
716 | <para> | ||
717 | Directory with kernel headers required to build out-of-tree | ||
718 | modules. | ||
719 | </para> | ||
720 | </glossdef> | ||
721 | </glossentry> | ||
722 | |||
723 | <glossentry id='var-STAMPS'><glossterm>STAMPS</glossterm> | ||
724 | <glossdef> | ||
725 | <para> | ||
726 | Directory (usually TMPDIR/stamps) with timestamps of | ||
727 | executed tasks. | ||
728 | </para> | ||
729 | </glossdef> | ||
730 | </glossentry> | ||
731 | |||
732 | </glossdiv> | ||
733 | |||
734 | <glossdiv id='var-glossary-t'><title>T</title> | ||
735 | |||
736 | <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm> | ||
737 | <glossdef> | ||
738 | <para>The architecture of the device we're building for. | ||
739 | A number of values are possible but Poky primarily supports | ||
740 | "arm" and "i586".</para> | ||
741 | </glossdef> | ||
742 | </glossentry> | ||
743 | |||
744 | <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm> | ||
745 | <glossdef> | ||
746 | <para> | ||
747 | Flags passed to C compiler for the target system. Evaluates to the same | ||
748 | as <link linkend='var-CFLAGS'>CFLAGS</link>. | ||
749 | </para> | ||
750 | </glossdef> | ||
751 | </glossentry> | ||
752 | |||
753 | |||
754 | <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm> | ||
755 | <glossdef> | ||
756 | <para>Method of handling FPU code. For FPU-less targets | ||
757 | (most of ARM cpus) it has to be set to "soft" otherwise | ||
758 | kernel emulation will get used which will result in | ||
759 | performance penalty.</para> | ||
760 | </glossdef> | ||
761 | </glossentry> | ||
762 | |||
763 | <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm> | ||
764 | <glossdef> | ||
765 | <para>Type of target operating system. Can be "linux" | ||
766 | for glibc based system, "linux-uclibc" for uClibc. For | ||
767 | ARM/EABI targets there are also "linux-gnueabi" and | ||
768 | "linux-uclibc-gnueabi" values possible.</para> | ||
769 | </glossdef> | ||
770 | </glossentry> | ||
771 | |||
772 | <glossentry id='var-TERMCMD'><glossterm>TERMCMD</glossterm> | ||
773 | <glossdef> | ||
774 | <para> | ||
775 | This command is used by bitbake to lauch a terminal window with a | ||
776 | shell. The shell is unspecified so the user's default shell is used. | ||
777 | By default it is set to <command>gnome-terminal</command> but it can | ||
778 | be any X11 terminal application or terminal multiplexers like screen. | ||
779 | </para> | ||
780 | </glossdef> | ||
781 | </glossentry> | ||
782 | |||
783 | <glossentry id='var-TERMCMDRUN'><glossterm>TERMCMDRUN</glossterm> | ||
784 | <glossdef> | ||
785 | <para> | ||
786 | This command is similar to <glossterm><link | ||
787 | linkend='var-TERMCMD'>TERMCMD</link></glossterm> however instead of the users shell it runs the command specified by the <glossterm><link | ||
788 | linkend='var-SHELLCMDS'>SHELLCMDS</link></glossterm> variable. | ||
789 | </para> | ||
790 | </glossdef> | ||
791 | </glossentry> | ||
792 | |||
793 | </glossdiv> | ||
794 | |||
795 | <!-- <glossdiv id='var-glossary-u'><title>U</title>--> | ||
796 | <!-- </glossdiv>--> | ||
797 | |||
798 | <!-- <glossdiv id='var-glossary-v'><title>V</title>--> | ||
799 | <!-- </glossdiv>--> | ||
800 | |||
801 | <glossdiv id='var-glossary-w'><title>W</title> | ||
802 | |||
803 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> | ||
804 | <glossdef> | ||
805 | <para>Path to directory in tmp/work/ where package | ||
806 | will be built.</para> | ||
807 | </glossdef> | ||
808 | </glossentry> | ||
809 | |||
810 | </glossdiv> | ||
811 | |||
812 | <!-- <glossdiv id='var-glossary-x'><title>X</title>--> | ||
813 | <!-- </glossdiv>--> | ||
814 | |||
815 | <!-- <glossdiv id='var-glossary-y'><title>Y</title>--> | ||
816 | <!-- </glossdiv>--> | ||
817 | |||
818 | <!-- <glossdiv id='var-glossary-z'><title>Z</title>--> | ||
819 | <!-- </glossdiv>--> | ||
820 | |||
821 | </glossary> | ||
822 | </appendix> | ||
823 | <!-- | ||
824 | vim: expandtab tw=80 ts=4 | ||
825 | --> | ||