xref: /OK3568_Linux_fs/yocto/poky/documentation/ref-manual/varlocality.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2*4882a593Smuzhiyun
3*4882a593Smuzhiyun****************
4*4882a593SmuzhiyunVariable Context
5*4882a593Smuzhiyun****************
6*4882a593Smuzhiyun
7*4882a593SmuzhiyunWhile you can use most variables in almost any context such as
8*4882a593Smuzhiyun``.conf``, ``.bbclass``, ``.inc``, and ``.bb`` files, some variables are
9*4882a593Smuzhiyunoften associated with a particular locality or context. This chapter
10*4882a593Smuzhiyundescribes some common associations.
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun.. _ref-varlocality-configuration:
13*4882a593Smuzhiyun
14*4882a593SmuzhiyunConfiguration
15*4882a593Smuzhiyun=============
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunThe following subsections provide lists of variables whose context is
18*4882a593Smuzhiyunconfiguration: distribution, machine, and local.
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun.. _ref-varlocality-config-distro:
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunDistribution (Distro)
23*4882a593Smuzhiyun---------------------
24*4882a593Smuzhiyun
25*4882a593SmuzhiyunThis section lists variables whose configuration context is the
26*4882a593Smuzhiyundistribution, or distro.
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun-  :term:`DISTRO`
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun-  :term:`DISTRO_NAME`
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun-  :term:`DISTRO_VERSION`
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun-  :term:`MAINTAINER`
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun-  :term:`PACKAGE_CLASSES`
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun-  :term:`TARGET_OS`
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun-  :term:`TARGET_FPU`
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun-  :term:`TCMODE`
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun-  :term:`TCLIBC`
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun.. _ref-varlocality-config-machine:
47*4882a593Smuzhiyun
48*4882a593SmuzhiyunMachine
49*4882a593Smuzhiyun-------
50*4882a593Smuzhiyun
51*4882a593SmuzhiyunThis section lists variables whose configuration context is the machine.
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun-  :term:`TARGET_ARCH`
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun-  :term:`SERIAL_CONSOLES`
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun-  :term:`PACKAGE_EXTRA_ARCHS`
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun-  :term:`IMAGE_FSTYPES`
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun-  :term:`MACHINE_FEATURES`
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun-  :term:`MACHINE_EXTRA_RDEPENDS`
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun-  :term:`MACHINE_EXTRA_RRECOMMENDS`
66*4882a593Smuzhiyun
67*4882a593Smuzhiyun-  :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun-  :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
70*4882a593Smuzhiyun
71*4882a593Smuzhiyun.. _ref-varlocality-config-local:
72*4882a593Smuzhiyun
73*4882a593SmuzhiyunLocal
74*4882a593Smuzhiyun-----
75*4882a593Smuzhiyun
76*4882a593SmuzhiyunThis section lists variables whose configuration context is the local
77*4882a593Smuzhiyunconfiguration through the ``local.conf`` file.
78*4882a593Smuzhiyun
79*4882a593Smuzhiyun-  :term:`DISTRO`
80*4882a593Smuzhiyun
81*4882a593Smuzhiyun-  :term:`MACHINE`
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun-  :term:`DL_DIR`
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun-  :term:`BBFILES`
86*4882a593Smuzhiyun
87*4882a593Smuzhiyun-  :term:`EXTRA_IMAGE_FEATURES`
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun-  :term:`PACKAGE_CLASSES`
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun-  :term:`BB_NUMBER_THREADS`
92*4882a593Smuzhiyun
93*4882a593Smuzhiyun-  :term:`BBINCLUDELOGS`
94*4882a593Smuzhiyun
95*4882a593Smuzhiyun-  :term:`ENABLE_BINARY_LOCALE_GENERATION`
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun.. _ref-varlocality-recipes:
98*4882a593Smuzhiyun
99*4882a593SmuzhiyunRecipes
100*4882a593Smuzhiyun=======
101*4882a593Smuzhiyun
102*4882a593SmuzhiyunThe following subsections provide lists of variables whose context is
103*4882a593Smuzhiyunrecipes: required, dependencies, path, and extra build information.
104*4882a593Smuzhiyun
105*4882a593Smuzhiyun.. _ref-varlocality-recipe-required:
106*4882a593Smuzhiyun
107*4882a593SmuzhiyunRequired
108*4882a593Smuzhiyun--------
109*4882a593Smuzhiyun
110*4882a593SmuzhiyunThis section lists variables that are required for recipes.
111*4882a593Smuzhiyun
112*4882a593Smuzhiyun-  :term:`LICENSE`
113*4882a593Smuzhiyun
114*4882a593Smuzhiyun-  :term:`LIC_FILES_CHKSUM`
115*4882a593Smuzhiyun
116*4882a593Smuzhiyun-  :term:`SRC_URI` - used in recipes that fetch local or remote files.
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun.. _ref-varlocality-recipe-dependencies:
119*4882a593Smuzhiyun
120*4882a593SmuzhiyunDependencies
121*4882a593Smuzhiyun------------
122*4882a593Smuzhiyun
123*4882a593SmuzhiyunThis section lists variables that define recipe dependencies.
124*4882a593Smuzhiyun
125*4882a593Smuzhiyun-  :term:`DEPENDS`
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun-  :term:`RDEPENDS`
128*4882a593Smuzhiyun
129*4882a593Smuzhiyun-  :term:`RRECOMMENDS`
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun-  :term:`RCONFLICTS`
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun-  :term:`RREPLACES`
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun.. _ref-varlocality-recipe-paths:
136*4882a593Smuzhiyun
137*4882a593SmuzhiyunPaths
138*4882a593Smuzhiyun-----
139*4882a593Smuzhiyun
140*4882a593SmuzhiyunThis section lists variables that define recipe paths.
141*4882a593Smuzhiyun
142*4882a593Smuzhiyun-  :term:`WORKDIR`
143*4882a593Smuzhiyun
144*4882a593Smuzhiyun-  :term:`S`
145*4882a593Smuzhiyun
146*4882a593Smuzhiyun-  :term:`FILES`
147*4882a593Smuzhiyun
148*4882a593Smuzhiyun.. _ref-varlocality-recipe-build:
149*4882a593Smuzhiyun
150*4882a593SmuzhiyunExtra Build Information
151*4882a593Smuzhiyun-----------------------
152*4882a593Smuzhiyun
153*4882a593SmuzhiyunThis section lists variables that define extra build information for
154*4882a593Smuzhiyunrecipes.
155*4882a593Smuzhiyun
156*4882a593Smuzhiyun-  :term:`DEFAULT_PREFERENCE`
157*4882a593Smuzhiyun
158*4882a593Smuzhiyun-  :term:`EXTRA_OECMAKE`
159*4882a593Smuzhiyun
160*4882a593Smuzhiyun-  :term:`EXTRA_OECONF`
161*4882a593Smuzhiyun
162*4882a593Smuzhiyun-  :term:`EXTRA_OEMAKE`
163*4882a593Smuzhiyun
164*4882a593Smuzhiyun-  :term:`PACKAGECONFIG_CONFARGS`
165*4882a593Smuzhiyun
166*4882a593Smuzhiyun-  :term:`PACKAGES`
167