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