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