summaryrefslogtreecommitdiffstats
path: root/handbook/ref-variables.xml
blob: 7aa360660b6b8a9bffba23e62ead74d459f3ebc9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!-- Dummy chapter -->
<appendix id='ref-variables-glos'>

<title>Reference: Variables Glossary</title>

<para>
    This section lists common variables used in Poky and gives an overview
    of their function and contents.
</para>

<glossary id='ref-variables-glossary'>


    <para>
       <link linkend='var-glossary-a'>A</link> 
       <link linkend='var-glossary-b'>B</link> 
       <link linkend='var-glossary-c'>C</link> 
       <link linkend='var-glossary-d'>D</link> 
       <link linkend='var-glossary-e'>E</link> 
       <link linkend='var-glossary-f'>F</link> 
<!--               <link linkend='var-glossary-g'>G</link> -->
       <link linkend='var-glossary-h'>H</link> 
       <link linkend='var-glossary-i'>I</link> 
<!--               <link linkend='var-glossary-j'>J</link> -->
       <link linkend='var-glossary-k'>K</link>
       <link linkend='var-glossary-l'>L</link> 
       <link linkend='var-glossary-m'>M</link> 
<!--               <link linkend='var-glossary-n'>N</link> -->
<!--               <link linkend='var-glossary-o'>O</link> -->
       <link linkend='var-glossary-p'>P</link> 
<!--               <link linkend='var-glossary-q'>Q</link> -->
       <link linkend='var-glossary-r'>R</link> 
       <link linkend='var-glossary-s'>S</link> 
       <link linkend='var-glossary-t'>T</link> 
<!--               <link linkend='var-glossary-u'>U</link> -->
<!--               <link linkend='var-glossary-v'>V</link> -->
       <link linkend='var-glossary-w'>W</link> 
<!--               <link linkend='var-glossary-x'>X</link> -->
<!--               <link linkend='var-glossary-y'>Y</link> -->
<!--               <link linkend='var-glossary-z'>Z</link>-->
    </para>

    <glossdiv id='var-glossary-a'><title>A</title>

         <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm>
            <glossdef>
                <para>E-mail address to contact original author(s) - to
                send patches, forward bugs...</para>
            </glossdef>
         </glossentry>

        <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
            <glossdef>
                <para>Use current (newest) source revision - used with
                    <glossterm><link linkend='var-SRCREV'>SRCREV</link></glossterm>
                    variable.</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-b'><title>B</title>

        <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
            <glossdef>
                <para>The maximum number of tasks BitBake should run in parallel at any one time</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
            <glossdef>
                <para>List of recipes used by BitBake to build software</para>
            </glossdef>
        </glossentry>

        <!-- BBPATH is not a usable variable in .bb files and should not be listed here -->

        <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm>
            <glossdef>
                <para>Variable which controls how BitBake displays logs on build failure.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-BPN'><glossterm>BPN</glossterm>
            <glossdef>
                <para>Bare name of package with any suffixes like -cross -native
                removed.  </para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-c'><title>C</title>

        <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm>
            <glossdef>
                <para>
                    Flags passed to C compiler for the target system. Evaluates to the same 
                    as <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm>
            <glossdef>
                <para>A regular expression which evalutates to match the machines the recipe 
                works with. It stops recipes being run on machines they're incompatible with 
                which is partciuarly useful with kernels. It also helps to to increase parsing 
                speed as if its found the current machine is not compatible, further parsing 
                of the recipe is skipped.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm>
            <glossdef>
                <para>
                    Contains a list of files which containing autoconf test results relevant 
                    to the current build. This variable is used by the autotools utilities 
                    when running configure.
                </para>
            </glossdef>
        </glossentry>


        <glossentry id='var-CVS_TARBALL_STASH'><glossterm>CVS_TARBALL_STASH</glossterm>
            <glossdef>
                <para>Location to search for
                pre-generated tarballs when fetching from remote SCM
                repositories (CVS/SVN/GIT)</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-d'><title>D</title>

        <glossentry id='var-D'><glossterm>D</glossterm>
            <glossdef>
                <para>Destination directory</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm>
            <glossdef>
                <para>
                    Build packages with debugging information. This influences the value 
                    <link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link> 
                    takes.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm>
            <glossdef>
                <para>
                    The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>
                    and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling a system for debugging.
                    This defaults to "-O -fno-omit-frame-pointer -g".
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm>
            <glossdef>
                <para>Priority of recipe</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm>
            <glossdef>
                <para>
                    A list of build time dependencies for a given recipe. These indicate 
                    recipes that must have staged before this recipe can configure.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm>
            <glossdef>
                <para>Package description used by package
                    managers</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DESTDIR'><glossterm>DESTDIR</glossterm>
            <glossdef>
                <para>Destination directory</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
            <glossdef>
                <para>Short name of distribution</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm>
            <glossdef>
                <para>List of packages required by distribution.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm>
            <glossdef>
                <para>List of packages which extend usability of
                    image. Those packages will be automatically
                    installed but can be removed by user.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm>
            <glossdef>
                <para>Features of the distribution.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm>
            <glossdef>
                <para>Long name of distribution</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm>
            <glossdef>
                <para>Alias names of the recipe in various Linux distributions.  </para>
                <para>See the "meta/package/xorg-app/xset_1.0.4.bb" file for an example</para>
                <para>More information in 
                    <link
                        linkend='usingpoky-configuring-DISTRO_PN_ALIAS'>
                        Configuring the DISTRO_PN_ALIAS variable section
                    </link>
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm>
            <glossdef>
                <para>Version of distribution</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm>
            <glossdef>
                <para>Directory where all fetched sources will be stored</para>
            </glossdef>

        </glossentry>
    </glossdiv>

    <glossdiv id='var-glossary-e'><title>E</title>

        <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm>
            <glossdef>
                <para>Variable which control which locales for glibc are
                to be generated during build (useful if target device
                has 64M RAM or less)</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm>
            <glossdef>
                <para>Additional 'configure' script options</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm>
            <glossdef>
                <para>Additional GNU make options</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-f'><title>F</title>

        <glossentry id='var-FILES'><glossterm>FILES</glossterm>
            <glossdef>
                <para>list of directories/files which will be placed
                    in packages</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm>
            <glossdef>
                <para>
                    The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>
                    and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling an optimised system.
                    This defaults to "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2".
                </para>
            </glossdef>
        </glossentry>

    </glossdiv>

<!--            <glossdiv id='var-glossary-g'><title>G</title>-->
<!--            </glossdiv>-->

    <glossdiv id='var-glossary-h'><title>H</title>

        <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm>
            <glossdef>
                <para>Website where more info about package can be found</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-i'><title>I</title>

        <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm>
            <glossdef>
                <para><link linkend="ref-features-image">List of
                features</link> present in resulting images</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm>
            <glossdef>
                <para>Formats of rootfs images which we want to have
                    created</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm>
            <glossdef>
                <para>List of packages used to build image</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm>
            <glossdef>
                <para>
                    This variable causes the build to not strip binaries in
                    resulting packages.
                </para>
            </glossdef>
        </glossentry>


        <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm>
            <glossdef>
                <para>
                    This variable causes the named class to be inherited at 
                    this point during parsing. Its only valid in configuration 
                    files.
                </para>
            </glossdef>
        </glossentry>


        <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm>
            <glossdef>
                <para>
                    Scope: Used in recipes when using update-rc.d.bbclass. Optional, defaults to PN.
                </para>
                <para>
                    A list of the packages which contain initscripts. If multiple 
                    packages are specified you need to append the package name 
                    to the other INITSCRIPT_* as an override.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm>
            <glossdef>
                <para>
                    Scope: Used in recipes when using update-rc.d.bbclass. Mandatory.
                </para>
                <para>
                    The filename of the initscript (as installed to ${etcdir}/init.d).
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm>
            <glossdef>
                <para>
                    Scope: Used in recipes when using update-rc.d.bbclass. Mandatory.
                </para>
                <para>
                    Specifies the options to pass to update-rc.d. An example is
                     "start 99 5 2 . stop 20 0 1 6 ." which gives the script a 
                    runlevel of 99, starts the script in initlevels 2 and 5 and 
                     stops it in levels 0, 1 and 6. 
                </para>
            </glossdef>
        </glossentry>


    </glossdiv>

<!--            <glossdiv id='var-glossary-j'><title>J</title>-->
<!--            </glossdiv>-->

   <glossdiv id='var-glossary-k'><title>K</title>

        <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm>
            <glossdef>
                <para>The type of kernel to build for a device, usually set by the 
                machine configuration files and defaults to "zImage". This is used 
                when building the kernel and is passed to "make" as the target to 
                build.</para>
            </glossdef>
        </glossentry>

   </glossdiv>

    <glossdiv id='var-glossary-l'><title>L</title>

        <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm>
            <glossdef>
                <para>When used inside a layer.conf gives the path of the
                current layer. This variable requires immediate expansion
                (see the Bitbake manual) as lazy expansion can result in
                the expansion happening in the wrong directory and therefore
                giving the wrong value.</para>
            </glossdef>
        </glossentry>
        <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm>
            <glossdef>
                <para>List of package source licenses.</para>
            </glossdef>
        </glossentry>
        <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm>
            <glossdef>
                <para>Checksums of the license text in the recipe source code.
                </para>
                <para>This variables tracks changes in license text of the source
                code files. If the license text is changed it triggers the build
                failure. Which gives developer an oppurtunity to review any 
                license changes</para>
                <para> This is an optional variable now. And the plan is to make
                it a required variable in the future </para>
                <para>See the "meta/package/zlib/zlib_${PV}.bb" file for an example</para>

                <para>More information in <link
                    linkend='usingpoky-configuring-LIC_FILES_CHKSUM'>
                    Configuring the LIC_FILES_CHKSUM variable section</link></para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-m'><title>M</title>

         <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm>
            <glossdef>
                <para>Target device</para>
            </glossdef>
         </glossentry>

         <glossentry id='var-MACHINE_ESSENTIAL_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_RDEPENDS</glossterm>
            <glossdef>
                <para>List of packages required to boot device</para>
            </glossdef>
         </glossentry>

         <glossentry id='var-MACHINE_ESSENTIAL_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_RRECOOMENDS</glossterm>
            <glossdef>
                <para>List of packages required to boot device (usually
                    additional kernel modules)</para>
            </glossdef>
        </glossentry>

         <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm>
            <glossdef>
                <para>List of packages required to use device</para>
            </glossdef>
         </glossentry>

         <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMNEDS</glossterm>
            <glossdef>
                <para>List of packages useful to use device (for example
                    additional kernel modules)</para>
            </glossdef>
         </glossentry>

         <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm>
            <glossdef>
                <para>List of device features - defined in <link
                    linkend='ref-features-machine'>machine
                    features section</link></para>
            </glossdef>
         </glossentry>

        <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm>
            <glossdef>
                <para>E-mail of distribution maintainer</para>
            </glossdef>
        </glossentry>
    </glossdiv>

<!--            <glossdiv id='var-glossary-n'><title>N</title>-->
<!--            </glossdiv>-->

<!--            <glossdiv id='var-glossary-o'><title>O</title>-->
<!--            </glossdiv>-->

    <glossdiv id='var-glossary-p'><title>P</title>

        <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm>
            <glossdef>
                <para>Architecture of resulting package</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm>
            <glossdef>
                <para>List of resulting packages formats</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm>
            <glossdef>
                <para>List of architectures compatible with device
                    CPU. Usable when build is done for few different
                    devices with misc processors (like XScale and
                    ARM926-EJS)</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm>
            <glossdef>
                <para>List of packages to be created from recipe.
                    The default value is "${PN}-dbg ${PN} ${PN}-doc ${PN}-dev"</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm>
            <glossdef>
                <para>Extra options that are passed to the make command during the 
                    compile tasks. This is usually of the form '-j 4' where the number
                    represents the maximum number of parallel threads make can run.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PN'><glossterm>PN</glossterm>
            <glossdef>
                <para>Name of package.
                    </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PR'><glossterm>PR</glossterm>
            <glossdef>
                <para>Revision of package.
                    </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PV'><glossterm>PV</glossterm>
            <glossdef>
                <para>Version of package.
                    The default value is "1.0"</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PE'><glossterm>PE</glossterm>
            <glossdef>
                <para>
                    Epoch of the package. The default value is "0". The field is used 
                    to make upgrades possible when the versioning scheme changes in 
                    some backwards incompatible way.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm>
            <glossdef>
                <para>If multiple recipes provide an item, this variable
                    determines which one should be given preference. It 
                    should be set to the "$PN" of the recipe to be preferred.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm>
            <glossdef>
                <para>
                    If there are multiple versions of recipe available, this
                    variable determines which one should be given preference. It
                    should be set to the "$PV" of the recipe to be preferred.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-POKY_EXTRA_INSTALL'><glossterm>POKY_EXTRA_INSTALL</glossterm>
            <glossdef>
                <para>List of packages to be added to the image. This should
                only be set in <filename>local.conf</filename>.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-POKYLIBC'><glossterm>POKYLIBC</glossterm>
            <glossdef>
                <para>Libc implementation selector - glibc or uclibc can be selected.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-POKYMODE'><glossterm>POKYMODE</glossterm>
            <glossdef>
                <para>Toolchain selector. It can be external toolchain
                built from Poky or few supported combinations of
                upstream GCC or CodeSourcery Labs toolchain.</para>
            </glossdef>
        </glossentry>

    </glossdiv>

<!--            <glossdiv id='var-glossary-q'><title>Q</title>-->
<!--            </glossdiv>-->

    <glossdiv id='var-glossary-r'><title>R</title>

        <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm>
            <glossdef>
                <para>List of packages which which conflict with this
                    one. Package will not be installed if they will not
                    be removed first.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm>
            <glossdef>
                <para>
                    A list of run-time dependencies for a package. These packages 
                    need to be installed alongside the package it applies to so 
                    the package will run correctly, an example is a perl script
                    which would rdepend on perl. Since this variable applies to 
                    output packages there would usually be an override attached 
                    to this variable like RDEPENDS_${PN}-dev. Names in this field 
                    should be as they are in <link linkend='var-PACKAGES'>PACKAGES
                    </link> namespace before any renaming of the output package
                    by classes like debian.bbclass.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-ROOT_FLASH_SIZE'><glossterm>ROOT_FLASH_SIZE</glossterm>
            <glossdef>
                <para>Size of rootfs in megabytes</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm>
            <glossdef>
                <para>List of packages which extend usability of
                    package. Those packages will be automatically
                    installed but can be removed by user.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm>
            <glossdef>
                <para>List of packages which are replaced with this
                    one.</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-s'><title>S</title>

        <glossentry id='var-S'><glossterm>S</glossterm>
            <glossdef>
                <para>
                    Path to unpacked sources (by default:
                    "${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}")
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SECTION'><glossterm>SECTION</glossterm>
            <glossdef>
                <para>Section where package should be put - used
                    by package managers</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm>
            <glossdef>
                <para>
                    The variable takes the value of <link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link>
                    unless <link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link> = "1" in which case 
                    <link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link> is used.
                </para>
            </glossdef>
        </glossentry>


        <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm>
            <glossdef>
                <para>Speed and device for serial port used to attach
                    serial console. This is given to kernel as "console"
                    param and after boot getty is started on that port
                    so remote login is possible.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SHELLCMDS'><glossterm>SHELLCMDS</glossterm>
            <glossdef>
                <para>
                    A list of commands to run within the a shell, used by <glossterm><link
                    linkend='var-TERMCMDRUN'>TERMCMDRUN</link></glossterm>. It defaults to  
                    <glossterm><link linkend='var-SHELLRCCMD'>SHELLRCCMD</link></glossterm>.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SHELLRCCMD'><glossterm>SHELLRCCMD</glossterm>
            <glossdef>
                <para>
                    How to launch a shell, defaults to bash.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SITEINFO_ENDIANESS'><glossterm>SITEINFO_ENDIANESS</glossterm>
            <glossdef>
                <para>
                    Contains "le" for little-endian or "be" for big-endian depending 
                    on the endian byte order of the target system.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm>
            <glossdef>
                <para>
                    Contains "32" or "64" depending on the number of bits for the 
                    CPU of the target system.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm>
            <glossdef>
                <para>List of source files (local or remote ones)</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm>
            <glossdef>
                <para>
                    By default there is code which automatically detects whether 
                    <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm>  
                    contains files which are machine specific and if this is the case it
                    automatically changes 
                    <glossterm><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></glossterm>. 
                    Setting this variable to "0" disables that behaviour.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm>
            <glossdef>
                <para>
                    Date of source code used to build package (if it was fetched
                    from SCM).
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm>
            <glossdef>
                <para>
                    Revision of source code used to build package (Subversion,
                    GIT, Bazaar only).
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm>
            <glossdef>
                <para>
                    Directory with kernel headers required to build out-of-tree
                    modules.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-STAMPS'><glossterm>STAMPS</glossterm>
            <glossdef>
                <para>
                    Directory (usually TMPDIR/stamps) with timestamps of
                    executed tasks.
                </para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-t'><title>T</title>

        <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm>
            <glossdef>
                <para>The architecture of the device we're building for. 
                A number of values are possible but Poky primarily supports
                "arm" and "i586".</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm>
            <glossdef>
                <para>
                    Flags passed to C compiler for the target system. Evaluates to the same 
                    as <link linkend='var-CFLAGS'>CFLAGS</link>.
                </para>
            </glossdef>
        </glossentry>


        <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm>
            <glossdef>
                <para>Method of handling FPU code. For FPU-less targets
                (most of ARM cpus) it has to be set to "soft" otherwise
                kernel emulation will get used which will result in
                performance penalty.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm>
            <glossdef>
                <para>Type of target operating system. Can be "linux"
                for glibc based system, "linux-uclibc" for uClibc. For
                ARM/EABI targets there are also "linux-gnueabi" and
                "linux-uclibc-gnueabi" values possible.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-TERMCMD'><glossterm>TERMCMD</glossterm>
            <glossdef>
                <para>
                    This command is used by bitbake to lauch a terminal window with a 
                    shell. The shell is unspecified so the user's default shell is used. 
                    By default it is set to <command>gnome-terminal</command> but it can 
                    be any X11 terminal application or terminal multiplexers like screen.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-TERMCMDRUN'><glossterm>TERMCMDRUN</glossterm>
            <glossdef>
                <para>
                    This command is similar to <glossterm><link
                linkend='var-TERMCMD'>TERMCMD</link></glossterm> however instead of the users shell it runs the command specified by the <glossterm><link
                linkend='var-SHELLCMDS'>SHELLCMDS</link></glossterm> variable.
                </para>
            </glossdef>
        </glossentry>

    </glossdiv>

<!--            <glossdiv id='var-glossary-u'><title>U</title>-->
<!--            </glossdiv>-->

<!--            <glossdiv id='var-glossary-v'><title>V</title>-->
<!--            </glossdiv>-->

    <glossdiv id='var-glossary-w'><title>W</title>

        <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
            <glossdef>
                <para>Path to directory in tmp/work/ where package
                    will be built.</para>
            </glossdef>
        </glossentry>

    </glossdiv>

<!--            <glossdiv id='var-glossary-x'><title>X</title>-->
<!--            </glossdiv>-->

<!--            <glossdiv id='var-glossary-y'><title>Y</title>-->
<!--            </glossdiv>-->

<!--            <glossdiv id='var-glossary-z'><title>Z</title>-->
<!--            </glossdiv>-->

</glossary>
</appendix>
<!-- 
vim: expandtab tw=80 ts=4 
-->