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