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
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
|
<!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 the Yocto Project and gives an overview
of their function and contents.
</para>
<glossary id='ref-variables-glossary'>
<para>
<link linkend='var-AUTHOR'>A</link>
<link linkend='var-BAD_RECOMMENDATIONS'>B</link>
<link linkend='var-CFLAGS'>C</link>
<link linkend='var-D'>D</link>
<link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link>
<link linkend='var-FILES'>F</link>
<!-- <link linkend='var-glossary-g'>G</link> -->
<link linkend='var-HOMEPAGE'>H</link>
<link linkend='var-IMAGE_FEATURES'>I</link>
<!-- <link linkend='var-glossary-j'>J</link> -->
<link linkend='var-KERNEL_FEATURES'>K</link>
<link linkend='var-LAYERDIR'>L</link>
<link linkend='var-MACHINE'>M</link>
<!-- <link linkend='var-glossary-n'>N</link> -->
<!-- <link linkend='var-glossary-o'>O</link> -->
<link linkend='var-PACKAGE_ARCH'>P</link>
<!-- <link linkend='var-glossary-q'>Q</link> -->
<link linkend='var-RCONFLICTS'>R</link>
<link linkend='var-S'>S</link>
<link linkend='var-TARGET_ARCH'>T</link>
<!-- <link linkend='var-glossary-u'>U</link> -->
<!-- <link linkend='var-glossary-v'>V</link> -->
<link linkend='var-WORKDIR'>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>The email address used to contact the original author or authors in
order to send patches, forward bugs, etc.</para>
</glossdef>
</glossentry>
<glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
<glossdef>
<para>Specifies to use the current (newest) source revision.
This variable is with the <filename><link linkend='var-SRCREV'>SRCREV</link></filename>
variable.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id='var-glossary-b'><title>B</title>
<glossentry id='var-BAD_RECOMMENDATIONS'><glossterm>BAD_RECOMMENDATIONS</glossterm>
<glossdef>
<para>A list of packages not to install despite being recommended by a recipe.
Support for this variable exists only for images that use the
<filename>ipkg</filename> packaging system.</para>
</glossdef>
</glossentry>
<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.
If your host development system supports mulitiple cores a good rule of thumb
is to set this variable to twice the number of cores.</para>
</glossdef>
</glossentry>
<glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm>
<glossdef>
<para>Lists the names of configured layers.
These names are used to find the other <filename>BBFILE_*</filename>
variables.
Typically, each layer will append its name to this variable in its
<filename>conf/layer.conf</filename> file.
</para>
</glossdef>
</glossentry>
<glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm>
<glossdef>
<para>Variable that expands to match files from <filename>BBFILES</filename> in a particular layer.
This variable is used in the <filename>conf/layer.conf</filename> file and must
be suffixed with the name of the specific layer (e.g.
<filename>BBFILE_PATTERN_emenlow</filename>).</para>
</glossdef>
</glossentry>
<glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm>
<glossdef>
<para>Assigns the priority for recipe files in each layer.</para>
<para>This variable is useful in situations where the same package appears in
more than one layer.
Setting this variable allows you to prioritize a
layer against other layers that contain the same package - effectively
letting you control the precedence for the multiple layers.
The precedence established through this variable stands regardless of a
layer's package version (<filename>PV</filename> variable).
For example, a layer that has a package with a higher <filename>PV</filename> value but for
which the <filename>BBFILE_PRIORITY</filename> is set to have a lower precedence still has a
lower precedence.</para>
<para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher
precedence.
For example, the value 6 has a higher precedence than the value 5.
If not specified, the <filename>BBFILE_PRIORITY</filename> variable is set based on layer
dependencies (see the
<filename><link linkend='var-LAYERDEPENDS'>LAYERDEPENDS</link></filename> variable for
more information.
The default priority, if unspecified
for a layer with no dependencies, is the lowest defined priority + 1
(or 1 if no priorities are defined).</para>
<tip>
You can use the command <filename>bitbake-layers show_layers</filename> to list
all configured layers along with their priorities.
</tip>
</glossdef>
</glossentry>
<glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
<glossdef>
<para>List of recipe files used by BitBake to build software</para>
</glossdef>
</glossentry>
<glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm>
<glossdef>
<para>Used by BitBake to locate <filename>.bbclass</filename> and configuration files.
This variable is analogous to the <filename>PATH</filename> variable.</para>
</glossdef>
</glossentry>
<glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm>
<glossdef>
<para>Variable that controls how BitBake displays logs on build failure.</para>
</glossdef>
</glossentry>
<glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm>
<glossdef>
<para>Lists the layers to enable during the Yocto Project build.
This variable is defined in the <filename>bblayers.conf</filename> configuration
file in the Yocto Project build directory.
Here is an example:
<literallayout class='monospaced'>
BBLAYERS = " \
/home/scottrif/poky/meta \
/home/scottrif/poky/meta-yocto \
/home/scottrif/poky/meta-mykernel \
"
</literallayout>
This example enables three layers, one of which is a custom, user-defined layer
named <filename>meta-mykernel</filename>.
</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.
This variable evaluates to the same as
<filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm>
<glossdef>
<para>A regular expression which evaluates to match the machines the recipe
works with.
It stops recipes being run on machines for which they are not compatible.
This is particularly useful with kernels.
It also helps to increase parsing speed as further parsing of the recipe is skipped
if it is found the current machine is not compatible.</para>
</glossdef>
</glossentry>
<glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm>
<glossdef>
<para>
A list of files that contains <filename>autoconf</filename> test results relevant
to the current build.
This variable is used by the Autotools utilities when running
<filename>configure</filename>.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id='var-glossary-d'><title>D</title>
<glossentry id='var-D'><glossterm>D</glossterm>
<glossdef>
<para>The destination directory.</para>
</glossdef>
</glossentry>
<glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm>
<glossdef>
<para>
Specifies to build packages with debugging information.
This influences the value of the
<filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename>
variable.
</para>
</glossdef>
</glossentry>
<glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm>
<glossdef>
<para>
The options to pass in
<filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>
and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling
a system for debugging.
This variable defaults to "-O -fno-omit-frame-pointer -g".
</para>
</glossdef>
</glossentry>
<glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm>
<glossdef>
<para>Specifies the priority of recipes.</para>
</glossdef>
</glossentry>
<glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm>
<glossdef>
<para>
A list of build-time dependencies for a given recipe.
The variable indicates recipes that must have been staged before a
particular recipe can configure.
</para>
</glossdef>
</glossentry>
<glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm>
<glossdef>
<para>The package description used by package managers.</para>
</glossdef>
</glossentry>
<glossentry id='var-DESTDIR'><glossterm>DESTDIR</glossterm>
<glossdef>
<para>the destination directory.</para>
</glossdef>
</glossentry>
<glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
<glossdef>
<para>The short name of the distribution.</para>
</glossdef>
</glossentry>
<glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm>
<glossdef>
<para>The list of packages required by the distribution.</para>
</glossdef>
</glossentry>
<glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm>
<glossdef>
<para>The list of packages which extend usability of the image.
Those packages will automatically be installed but can be removed by user.</para>
</glossdef>
</glossentry>
<glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm>
<glossdef>
<para>The features of the distribution.</para>
</glossdef>
</glossentry>
<glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm>
<glossdef>
<para>The long name of the distribution.</para>
</glossdef>
</glossentry>
<glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm>
<glossdef>
<para>Alias names used for the recipe in various Linux distributions.</para>
<para>See <link linkend='usingpoky-configuring-DISTRO_PN_ALIAS'>
Handling a Package Name Alias</link> section for more information.</para>
</glossdef>
</glossentry>
<glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm>
<glossdef>
<para>the version of the distribution.</para>
</glossdef>
</glossentry>
<glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm>
<glossdef>
<para>The 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 that controls which locales for <filename>eglibc</filename> are
to be generated during the build (useful if the target device has 64Mbytes
of RAM or less).</para>
</glossdef>
</glossentry>
<glossentry id='var-EXTRA_IMAGE_FEATURES'><glossterm>EXTRA_IMAGE_FEATURES</glossterm>
<glossdef>
<para>Allows extra packages to be added to the generated images.
You set this variable in the <filename>local.conf</filename>
configuration file.
Note that some image features are also added using the
<filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>
variable generally configured in image recipes.
You can use this variable to add more features in addition to those.
Here are some examples of features you can add:</para>
<literallayout class='monospaced'>
"dbg-pkgs" - Adds -dbg packages for all installed packages
including symbol information for debugging and
profiling.
"dev-pkgs" - Adds -dev packages for all installed packages.
This is useful if you want to develop against
the libraries in the image.
"tools-sdk" - Adds development tools such as gcc, make,
pkgconfig and so forth.
"tools-debug" - Adds debugging tools such as gdb and
strace.
"tools-profile" - Adds profiling tools such as oprofile,
exmap, lttng and valgrind (x86 only).
"tools-testapps" - Adds useful testing tools such as
ts_print, aplay, arecord and so
forth.
"debug-tweaks" - Makes an image suitable for development.
For example, ssh root access has a blank
password. You should remove this feature
before you produce a production image.
There are other application targets too, see
<filename>meta/classes/poky-image.bbclass</filename>
and <filename>meta/packages/tasks/task-poky.bb</filename>
for more details.
</literallayout>
</glossdef>
</glossentry>
<glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm>
<glossdef>
<para>Additional <filename>cmake</filename> options.</para>
</glossdef>
</glossentry>
<glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm>
<glossdef>
<para>Additional <filename>configure</filename> script options.</para>
</glossdef>
</glossentry>
<glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm>
<glossdef>
<para>Additional GNU <filename>make</filename> options.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id='var-glossary-f'><title>F</title>
<glossentry id='var-FILES'><glossterm>FILES</glossterm>
<glossdef>
<para>The list of directories or files that are placed in packages.</para>
</glossdef>
</glossentry>
<glossentry id='var-FILESYSTEM_PERMS_TABLES'><glossterm>FILESYSTEM_PERMS_TABLES</glossterm>
<glossdef>
<para>Allows you to define your own file permissions settings table as part of
your configuration for the packaging process.
For example, suppose you need a consistent set of custom permissions for
a set of groups and users across an entire work project.
It is best to do this in the packages themselves but this is not always
possible.
</para>
<para>
By default, the Yocto Project uses the <filename>fs-perms.txt</filename>, which
is located in the <filename>meta/files</filename> directory of the Yocto Project
files directory.
If you create your own file permissions setting table, you should place it in your
layer or the distros layer.
</para>
<para>
You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the
<filename>conf/local.conf</filename> file, which is found in the Yocto Project's
build directory, to point to your custom <filename>fs-perms.txt</filename>.
You can specify more than a single file permissions setting table.
The paths you specify to these files must be defined within the
<filename>BBPATH</filename> variable.
</para>
<para>
For guidance on how to create your own file permissions settings table file,
examine the existing <filename>fs-perms.txt</filename>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm>
<glossdef>
<para>
The options to pass in
<filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>
and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>
when compiling an optimised system.
This variable 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>The list of features present in images.
Typically, you configure this variable in image recipes.
Note that you can add extra features to the image by using the
<filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable.
See the <link linkend="ref-features-image">Reference: Images</link> section for the
list of features present in images built by the Yocto Project.</para>
</glossdef>
</glossentry>
<glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm>
<glossdef>
<para>Formats of root filesystem images that you want to have created.</para>
</glossdef>
</glossentry>
<glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm>
<glossdef>
<para>The list of packages used to build images.</para>
</glossdef>
</glossentry>
<glossentry id='var-INC_PR'><glossterm>INC_PR</glossterm>
<glossdef>
<para>Defines the Package revision.
You manually combine values for <filename>INC_PR</filename> into the
<filename>PR</filename> field of the parent recipe.
When you change this variable, you change the <filename>PR</filename>
value for every person that includes the file.</para>
<para>
The following example shows how to use the <filename>INC_PR</filename> variable
given a common <filename>.inc</filename> file that defines the variable.
Once defined, you can use the variable to set the <filename>PR</filename> value:
</para>
<literallayout class='monospaced'>
recipes-graphics/xorg-font/font-util_1.1.1.bb:PR - "$(INC_PR).1"
recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR - "r1"
recipes-graphics/xorg-font/encondings_1.0.3.bb:PR - "$(INC_PR).1"
recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
</literallayout>
</glossdef>
</glossentry>
<glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm>
<glossdef>
<para>
Causes the build to not strip binaries in resulting packages.
</para>
</glossdef>
</glossentry>
<glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm>
<glossdef>
<para>
Causes the named class to be inherited at
this point during parsing.
The variable is only valid in configuration files.
</para>
</glossdef>
</glossentry>
<glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm>
<glossdef>
<para>
A list of the packages that contain initscripts.
If multiple packages are specified, you need to append the package name
to the other <filename>INITSCRIPT_*</filename> as an override.</para>
<para>
This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>.
The variable is optional and defaults to the <filename>PN</filename> variable.
</para>
</glossdef>
</glossentry>
<glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm>
<glossdef>
<para>
The filename of the initscript (as installed to <filename>${etcdir}/init.d)</filename>.
</para>
<para>
This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>.
The variable is Mandatory.
</para>
</glossdef>
</glossentry>
<glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm>
<glossdef>
<para>
Specifies the options to pass to <filename>update-rc.d</filename>.
An example is <filename>start 99 5 2 . stop 20 0 1 6 .</filename>, which gives the script a
runlevel of 99, starts the script in initlevels 2 and 5, and
stops the script in levels 0, 1 and 6.
</para>
<para>
The variable is mandatory and is used in recipes when using
<filename>update-rc.d.bbclass</filename>.
</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_FEATURES'><glossterm>KERNEL_FEATURES</glossterm>
<glossdef>
<para>Includes additional metadata from the Linux Yocto kernel Git repository.
In the Yocto Project build system, the default Board Support Packages (BSPs)
metadata is provided through
the <filename>KMACHINE</filename> and <filename>KBRANCH</filename> variables.
You can use the <filename>KERNEL_FEATURES</filename> variable to further
add metadata for all BSPs.</para>
<para>The metadata you add through this variable includes config fragments and
features descriptions,
which usually includes patches as well as config fragments.
You typically override the <filename>KERNEL_FEATURES</filename> variable
for a specific machine.
In this way, you can provide validated, but optional, sets of kernel
configurations and features.</para>
<para>For example, the following adds <filename>netfilter</filename> to all
the Linux Yocto kernels and adds sound support to the <filename>qemux86</filename>
machine:
<literallayout class='monospaced'>
# Add netfilter to all linux-yocto kernels
KERNEL_FEATURES="features/netfilter"
# Add sound support to the qemux86 machine
KERNEL_FEATURES_append_qemux86="cfg/sound"
</literallayout></para>
</glossdef>
</glossentry>
<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 variable is used
when building the kernel and is passed to <filename>make</filename> as the target to
build.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id='var-glossary-l'><title>L</title>
<glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm>
<glossdef>
<para>Lists the layers that this recipe depends upon, separated by spaces.
Optionally, you can specify a specific layer version for a dependency
by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3"
to be compared against <filename>LAYERVERSION_anotherlayer</filename> in this case).
An error will be produced if any dependency is missing or
the version numbers do not match exactly (if specified).
This variable is used in the <filename>conf/layer.conf</filename> file
and must be suffixed with the name of the specific layer (e.g.
<filename>LAYERDEPENDS_mylayer</filename>).</para>
</glossdef>
</glossentry>
<glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm>
<glossdef>
<para>When used inside the <filename>layer.conf</filename> configuration
file, this variable provides 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-LAYERVERSION'><glossterm>LAYERVERSION</glossterm>
<glossdef>
<para>Optionally specifies the version of a layer as a single number.
You can use this within <filename>LAYERDEPENDS</filename> for another layer in order to
depend on a specific version of the layer.
This variable is used in the <filename>conf/layer.conf</filename> file
and must be suffixed with the name of the specific layer (e.g.
<filename>LAYERVERSION_mylayer</filename>).</para>
</glossdef>
</glossentry>
<glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm>
<glossdef>
<para>The 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 variable tracks changes in license text of the source
code files.
If the license text is changed, it will trigger a build
failure, which gives the developer an opportunity to review any
license change.</para>
<para>
This variable must be defined for all recipes (unless <filename>LICENSE</filename>
is set to "CLOSED")</para>
<para>For more information, see the
<link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'>
Track License Change</link> section</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id='var-glossary-m'><title>M</title>
<glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm>
<glossdef>
<para>Specifies the target device.</para>
</glossdef>
</glossentry>
<glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm>
<glossdef>
<para>
A list of required packages to install as part of the package being
built.
The build process depends on these packages being present.
Furthermore, because this is a "machine essential" variable, the list of
packages are essential for the machine to boot.
The impact of this variable affects images based on <filename>task-core-boot</filename>,
including the <filename>core-image-minimal</filename> image.
</para>
<para>
This variable is similar to the
<link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link>
variable with the exception that the package being built has a build
dependency on the variable's list of packages.
In other words, the image will not build if a file in this list is not found.
</para>
<para>
For example, suppose you are building a runtime package that depends
on a certain disk driver.
In this case, you would use the following:
<literallayout class='monospaced'>
MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "<disk_driver>"
</literallayout>
</para>
</glossdef>
</glossentry>
<glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm>
<glossdef>
<para>
A list of recommended packages to install as part of the package being
built.
The build process does not depend on these packages being present.
Furthermore, because this is a "machine essential" variable, the list of
packages are essential for the machine to boot.
The impact of this variable affects images based on <filename>task-core-boot</filename>,
including the <filename>core-image-minimal</filename> image.
</para>
<para>
This variable is similar to the
<link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link>
variable with the exception that the package being built does not have a build
dependency on the variable's list of packages.
In other words, the image will build if a file in this list is not found.
However, because this is one of the "essential" variables, the resulting image
might not boot on the machine.
Or, if the machine does boot using the image, the machine might not be fully
functional.
</para>
<para>
Consider an example where you have a custom kernel with a disk driver
built into the kernel itself, rather than using the driver built as a module.
If you include the package that has the driver module as part of
the variable's list, the
build process will not find that package.
However, because these packages are "recommends" packages, the build will
not fail due to the missing package.
Not accounting for any other problems, the custom kernel would still boot the machine.
</para>
<para>
Some example packages of these machine essentials are flash, screen, keyboard, mouse,
or touchscreen drivers (depending on the machine).
</para>
<para>
For example, suppose you are building a runtime package that depends
on a mouse driver.
In this case, you would use the following:
<literallayout class='monospaced'>
MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "<mouse_driver>"
</literallayout>
</para>
</glossdef>
</glossentry>
<glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm>
<glossdef>
<para>
A list of optional but non-machine essential packages to install as
part of the package being built.
Even though these packages are not essential for the machine to boot,
the build process depends on them being present.
The impact of this variable affects all images based on
<filename>task-base</filename>, which does not include the
<filename>core-image-minimal</filename> or <filename>core-image-basic</filename>
images.
</para>
<para>
This variable is similar to the
<link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link>
variable with the exception that the package being built has a build
dependency on the variable's list of packages.
In other words, the image will not build if a file in this list is not found.
</para>
<para>
An example is a machine that might or might not have a WiFi card.
The package containing the WiFi support is not essential for the
machine to boot the image.
If it is not there, the machine will boot but not be able to use the
WiFi functionality.
However, if you include the package with the WiFi support as part of the
variable's package list, the build
process depends on finding the package.
In this case, you would use the following:
<literallayout class='monospaced'>
MACHINE_EXTRA_RDEPENDS += "<wifi_driver>"
</literallayout>
</para>
</glossdef>
</glossentry>
<glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm>
<glossdef>
<para>
A list of optional but non-machine essential packages to install as
part of the package being built.
The package being built has no build dependency on the list of packages
with this variable.
The impact of this variable affects only images based on
<filename>task-base</filename>, which does not include the
<filename>core-image-minimal</filename> or <filename>core-image-basic</filename>
images.
</para>
<para>
This variable is similar to the
<link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link>
variable with the exception that the package being built does not have a build
dependency on the variable's list of packages.
In other words, the image will build if a file in this list is not found.
</para>
<para>
An example is a machine that might or might not have a WiFi card.
The package containing the WiFi support is not essential for the
machine to boot the image.
If it is not there, the machine will boot but not be able to use the
WiFi functionality.
You are free to either include or not include the
the package with the WiFi support as part of the
variable's package list, the build
process does not depend on finding the package.
If you include the package, you would use the following:
<literallayout class='monospaced'>
MACHINE_EXTRA_RRECOMMENDS += "<wifi_driver>"
</literallayout>
</para>
</glossdef>
</glossentry>
<glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm>
<glossdef>
<para>Specifies the list of device features.
See the <link linkend='ref-features-machine'>Machine</link> section for
more information.</para>
</glossdef>
</glossentry>
<glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm>
<glossdef>
<para>The email address of the 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>The architecture of the resulting package.</para>
</glossdef>
</glossentry>
<glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm>
<glossdef>
<para>This variable, which is set in the <filename>local.conf</filename> configuration
file found in the Yocto Project file's <filename>conf</filename> directory,
specifies the package manager to use when packaging data.
You can provide one or more arguments for the variable with the first
argument being the package manager used to create images:
<literallayout class='monospaced'>
PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
</literallayout>
For information on build performance effects as a result of the
package manager use, see
<link linkend='ref-classes-package'>Packaging - <filename>package*.bbclass</filename></link>
in this manual.
</para>
</glossdef>
</glossentry>
<glossentry id='var-PACKAGE_DESCRIPTION'><glossterm>PACKAGE_DESCRIPTION</glossterm>
<glossdef>
<para>The long form description of the binary package for packaging systems such as
<filename>ipkg</filename>, <filename>rpm</filename> or <filename>debian</filename>.
By default, this variable inherits <filename>DESCRIPTION</filename>.</para>
</glossdef>
</glossentry>
<glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm>
<glossdef>
<para>Specifies the list of architectures compatible with the device CPU.
This variable is useful when you build for several different devices that use
miscellaneous processors such as XScale and ARM926-EJS).</para>
</glossdef>
</glossentry>
<glossentry id='var-PACKAGE_SUMMARY'><glossterm>PACKAGE_SUMMARY</glossterm>
<glossdef>
<para>The short (72 character limit suggested) summary of the binary
package for packaging systems such as <filename>ipkg</filename>,
<filename>rpm</filename> or <filename>debian</filename>.
By default, this variable inherits <filename>DESCRIPTION</filename>.</para>
</glossdef>
</glossentry>
<glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm>
<glossdef>
<para>The list of packages to be created from the 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>Specifies extra options that are passed to the <filename>make</filename> command during the
compile tasks.
This variable is usually in the form <filename>-j 4</filename>, where the number
represents the maximum number of parallel threads make can run.
If you development host supports multiple cores a good rule of thumb is to set
this variable to twice the number of cores on the host.</para>
</glossdef>
</glossentry>
<glossentry id='var-PN'><glossterm>PN</glossterm>
<glossdef>
<para>The name of the package.
</para>
</glossdef>
</glossentry>
<glossentry id='var-PR'><glossterm>PR</glossterm>
<glossdef>
<para>The revision of the package.
The default value for this variable is "r0".
</para>
</glossdef>
</glossentry>
<glossentry id='var-PV'><glossterm>PV</glossterm>
<glossdef>
<para>The version of the package.
The version is normally extracted from the recipe name.
For example, if the recipe is named
<filename>expat_2.0.1.bb</filename>, then <filename>PV</filename>
will be <filename>2.0.1</filename>.
<filename>PV</filename> is generally not overridden within
a recipe unless it is building an unstable version from a source code repository
(e.g. Git or Subversion).
</para>
</glossdef>
</glossentry>
<glossentry id='var-PE'><glossterm>PE</glossterm>
<glossdef>
<para>
the 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 recipe should be given preference.
The variable must always be suffixed with the name of the
provided item, and should be set to the
<filename>$PN</filename> of the recipe
to which you want to give precedence.
Here is an example:
<literallayout class='monospaced'>
PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
</literallayout>
</para>
</glossdef>
</glossentry>
<glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm>
<glossdef>
<para>
If there are multiple versions of recipes available, this
variable determines which recipe should be given preference.
The variable must always be suffixed with the <filename>$PN</filename>
for which to select, and should be set to the
<filename>$PV</filename> to which you want to give precedence.
You can use the "<filename>%</filename>" character as a wildcard
to match any number of characters, which can be useful when
specifying versions that contain long revision number that could
potentially change.
Here are two examples:
<literallayout class='monospaced'>
PREFERRED_VERSION_python = "2.6.6"
PREFERRED_VERSION_linux-yocto = "3.0+git%"
</literallayout>
</para>
</glossdef>
</glossentry>
<glossentry id='var-POKY_EXTRA_INSTALL'><glossterm>POKY_EXTRA_INSTALL</glossterm>
<glossdef>
<para>Specifies the list of packages to be added to the image.
This variable should only be set in the <filename>local.conf</filename>
configuration file found in the Yocto Project's build directory.</para>
</glossdef>
</glossentry>
<glossentry id='var-POKYLIBC'><glossterm>POKYLIBC</glossterm>
<glossdef>
<para>
This variable is no longer supported and has been replaced by the
<link linkend='var-TCLIBC'><filename>TCLIBC</filename></link> variable.
</para>
</glossdef>
</glossentry>
<glossentry id='var-POKYMODE'><glossterm>POKYMODE</glossterm>
<glossdef>
<para>
This variable is no longer supported and has been replaced by the
<link linkend='var-TCMODE'><filename>TCMODE</filename></link> variable.
</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>The list of packages that conflict with this package.
Note that the package will not be installed if the conflicting packages are not
first removed.</para>
</glossdef>
</glossentry>
<glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm>
<glossdef>
<para>
A list of packages that must be installed as part of a package being built.
The package being built has a runtime dependency on the packages in the
variable's list.
In other words, in order for the package being built to run correctly,
it depends on these listed packages.
If a package in this list cannot be found during the build, the build
will not complete.
</para>
<para>
Because the <filename>RDEPENDS</filename> variable applies to packages
being built, you should
always attach an override to the variable to specify the particular runtime package
that has the dependency.
For example, suppose you are building a development package that depends
on the <filename>perl</filename> package.
In this case, you would use the following <filename>RDEPENDS</filename>
statement:
<literallayout class='monospaced'>
RDEPENDS_${PN}-dev += "perl"
</literallayout>
In the example, the package name (<filename>${PN}-dev</filename>) must
appear as it would in the
<filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> namespace before any
renaming of the output package by classes like <filename>debian.bbclass</filename>.
</para>
<para>
Some automatic handling occurs around the <filename>RDEPENDS</filename>
variable:
<itemizedlist>
<listitem><para><emphasis><filename>shlibdeps</filename></emphasis>: If a runtime
package contains a shared library (<filename>.so</filename>), the build
processes the library in order to determine other libraries to which it
is dynamically linked.
The build process adds these libraries to <filename>RDEPENDS</filename>
to create the runtime package.</para></listitem>
<listitem><para><emphasis><filename>pcdeps</filename></emphasis>: If the package
ships a <filename>pkg-config</filename> information file, the build process
uses this file to add items to the <filename>RDEPENDS</filename>
variable to create the runtime packages.
</para></listitem>
</itemizedlist>
</para>
</glossdef>
</glossentry>
<glossentry id='var-ROOT_FLASH_SIZE'><glossterm>ROOT_FLASH_SIZE</glossterm>
<glossdef>
<para>The size of root filesystem as measured in megabytes.</para>
</glossdef>
</glossentry>
<glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm>
<glossdef>
<para>
A list of packages that extend the usability of a package being
built.
The package being built does not depend on this list of packages in
order to successfully build, but needs them for the extended usability.
To specify runtime dependencies for packages, see the
<link linkend='var-RDEPENDS'>RDEPENDS</link> variable.
</para>
<para>
The Yocto Project build process automatically installs the list of packages
as part of the built package.
However, you can remove them later if you want.
If, during the build, a package from the list cannot be found, the build
process continues without an error.
</para>
<para>
Because the <filename>RRECOMMENDS</filename> variable applies to packages
being built, you should
always attach an override to the variable to specify the particular package
whose usability is being extended.
For example, suppose you are building a development package that is extended
to support wireless functionality.
In this case, you would use the following:
<literallayout class='monospaced'>
RRECOMMENDS_${PN}-dev += "<wireless_package_name>"
</literallayout>
In the example, the package name (<filename>${PN}-dev</filename>) must
appear as it would in the
<filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> namespace before any
renaming of the output package by classes like <filename>debian.bbclass</filename>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm>
<glossdef>
<para>The list of packages that are replaced with this package.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id='var-glossary-s'><title>S</title>
<glossentry id='var-S'><glossterm>S</glossterm>
<glossdef>
<para>
The path to unpacked sources.
By default, this path is
"${<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>The section where package should be put.
Package managers use this variable.</para>
</glossdef>
</glossentry>
<glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm>
<glossdef>
<para>
The variable takes the value of
<filename><link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link></filename>
unless <filename><link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link></filename> = "1".
In this case the value of
<filename><link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link></filename> is used.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm>
<glossdef>
<para>The speed and device for the serial port used to attach the serial console.
This variable is given to the kernel as the "console"
parameter and after booting occurs <filename>getty</filename> is started on that port
so remote login is possible.</para>
</glossdef>
</glossentry>
<glossentry id='var-SSTATE_DIR'><glossterm>SSTATE_DIR</glossterm>
<glossdef>
<para>The directory for the shared state.</para>
</glossdef>
</glossentry>
<glossentry id='var-SHELLCMDS'><glossterm>SHELLCMDS</glossterm>
<glossdef>
<para>
A list of commands to run within the shell.
The list is used by <filename><link linkend='var-TERMCMDRUN'>TERMCMDRUN</link></filename>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SITEINFO_ENDIANNESS'><glossterm>SITEINFO_ENDIANNESS</glossterm>
<glossdef>
<para>
Specifies the endian byte order of the target system.
The variable is either "le" for little-endian or "be" for big-endian.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm>
<glossdef>
<para>
Specifies the number of bits for the target system CPU.
The variable is either "32" or "64".
</para>
</glossdef>
</glossentry>
<glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm>
<glossdef>
<para>The list of source files - local or remote.</para>
</glossdef>
</glossentry>
<glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm>
<glossdef>
<para>
By default, the Yocto Project automatically detects whether
<filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>
contains files that are machine-specific.
If so, the Yocto Project automatically changes
<filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>.
Setting this variable to "0" disables this behaviour.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm>
<glossdef>
<para>
The date of the source code used to build the package.
This variable applies only if the source was fetched from a Source Code Manager (SCM).
</para>
</glossdef>
</glossentry>
<glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm>
<glossdef>
<para>
The revision of the source code used to build the package.
This variable applies to Subversion, Git, Mercurial and Bazaar
only.
Note that if you wish to build a fixed revision and you wish
to avoid performing a query on the remote repository every time
BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a
full revision identifier and not just a tag.
</para>
</glossdef>
</glossentry>
<glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm>
<glossdef>
<para>
The directory with kernel headers that are required to build out-of-tree
modules.
</para>
</glossdef>
</glossentry>
<glossentry id='var-STAMPS'><glossterm>STAMPS</glossterm>
<glossdef>
<para>
The directory (usually <filename>TMPDIR/stamps</filename>) with timestamps of
executed tasks.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm>
<glossdef>
<para>The short (72 characters or less) summary of the binary package for packaging
systems such as <filename>ipkg</filename>, <filename>rpm</filename> or
<filename>debian</filename>.
By default, this variable inherits <filename>DESCRIPTION</filename>.</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 being built.
While a number of values are possible, the Yocto Project primarily supports
<filename>arm</filename> and <filename>i586</filename>.</para>
</glossdef>
</glossentry>
<glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm>
<glossdef>
<para>
Flags passed to the C compiler for the target system.
This variable evaluates to the same as
<filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm>
<glossdef>
<para>Specifies the method for handling FPU code.
For FPU-less targets, which include most ARM CPUs, the variable must be
set to "soft".
If not, the kernel emulation gets used, which results in a performance penalty.</para>
</glossdef>
</glossentry>
<glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm>
<glossdef>
<para>Specifies the target's operating system.
The variable can be set to "linux" for <filename>eglibc</filename>-based systems and
to "linux-uclibc" for <filename>uclibc</filename>.
For ARM/EABI targets, there are also "linux-gnueabi" and
"linux-uclibc-gnueabi" values possible.</para>
</glossdef>
</glossentry>
<glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm>
<glossdef>
<para>
Specifies which variant of the GNU standard C library (<filename>libc</filename>)
to use during the build process.
This variable replaces <filename>POKYLIBC</filename>, which is no longer
supported.
</para>
<para>
You can select <filename>eglibc</filename> or <filename>uclibc</filename>.
<note>
This release of the Yocto Project does not support the
<filename>glibc</filename> implementation of <filename>libc</filename>.
</note>
</para>
</glossdef>
</glossentry>
<glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm>
<glossdef>
<para>
The toolchain selector.
This variable replaces <filename>POKYMODE</filename>, which is no longer
supported.
</para>
<para>
The <filename>TCMODE</filename> variable selects the external toolchain
built from the Yocto Project or a few supported combinations of
the upstream GCC or CodeSourcery Labs toolchain.
The variable determines which of the files in
<filename>meta/conf/distro/include/tcmode-*</filename> is used.
</para>
<para>
By default, <filename>TCMODE</filename> is set to "default", which
chooses <filename>tcmode-default.inc</filename>.
The variable is similar to <filename>TCLIBC</filename>, which controls
the variant of the GNU standard C library (<filename>libc</filename>)
used during the build process: <filename>eglibc</filename> or <filename>uclibc</filename>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-TERMCMD'><glossterm>TERMCMD</glossterm>
<glossdef>
<para>
This command is used by BitBake to launch a terminal window with a
shell.
The shell is unspecified so the user's default shell is used.
By default, the variable is set to "xterm" but it can
be any X11 terminal application or a terminal multiplexer such as screen.
</para>
<note>
While <filename>KONSOLE_TERMCMD</filename> and
<filename>KONSOLE_TERMCMDRUN</filename> are provided
and will work with KDE's Konsole terminal application Konsole from KDE 3,
Konsole in KDE 4.0 and later versions will no longer work here due to the fact
that it now launches in the background by default, and it is not practically
possible to wait until it has terminated.
It is hoped that this can be fixed
in a future version.
</note>
</glossdef>
</glossentry>
<glossentry id='var-TERMCMDRUN'><glossterm>TERMCMDRUN</glossterm>
<glossdef>
<para>
This variable is similar to
<filename><link linkend='var-TERMCMD'>TERMCMD</link></filename>.
However, instead of running the user's shell, the command specified by
the <filename><link linkend='var-SHELLCMDS'>SHELLCMDS</link></filename>
variable is run.
</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>The path to directory in <filename>tmp/work/</filename> where
the package is 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
-->
|