summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/varlocality.rst
blob: 5f7dba8775ae672b57168f3b455765e790749632 (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
.. SPDX-License-Identifier: CC-BY-SA-2.0-UK

****************
Variable Context
****************

While you can use most variables in almost any context such as
``.conf``, ``.bbclass``, ``.inc``, and ``.bb`` files, some variables are
often associated with a particular locality or context. This chapter
describes some common associations.

.. _ref-varlocality-configuration:

Configuration
=============

The following subsections provide lists of variables whose context is
configuration: distribution, machine, and local.

.. _ref-varlocality-config-distro:

Distribution (Distro)
---------------------

This section lists variables whose configuration context is the
distribution, or distro.

-  :term:`DISTRO`

-  :term:`DISTRO_NAME`

-  :term:`DISTRO_VERSION`

-  :term:`MAINTAINER`

-  :term:`PACKAGE_CLASSES`

-  :term:`TARGET_OS`

-  :term:`TARGET_FPU`

-  :term:`TCMODE`

-  :term:`TCLIBC`

.. _ref-varlocality-config-machine:

Machine
-------

This section lists variables whose configuration context is the machine.

-  :term:`TARGET_ARCH`

-  :term:`SERIAL_CONSOLES`

-  :term:`PACKAGE_EXTRA_ARCHS`

-  :term:`IMAGE_FSTYPES`

-  :term:`MACHINE_FEATURES`

-  :term:`MACHINE_EXTRA_RDEPENDS`

-  :term:`MACHINE_EXTRA_RRECOMMENDS`

-  :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`

-  :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`

.. _ref-varlocality-config-local:

Local
-----

This section lists variables whose configuration context is the local
configuration through the ``local.conf`` file.

-  :term:`DISTRO`

-  :term:`MACHINE`

-  :term:`DL_DIR`

-  :term:`BBFILES`

-  :term:`EXTRA_IMAGE_FEATURES`

-  :term:`PACKAGE_CLASSES`

-  :term:`BB_NUMBER_THREADS`

-  :term:`BBINCLUDELOGS`

-  :term:`ENABLE_BINARY_LOCALE_GENERATION`

.. _ref-varlocality-recipes:

Recipes
=======

The following subsections provide lists of variables whose context is
recipes: required, dependencies, path, and extra build information.

.. _ref-varlocality-recipe-required:

Required
--------

This section lists variables that are required for recipes.

-  :term:`LICENSE`

-  :term:`LIC_FILES_CHKSUM`

-  :term:`SRC_URI` - used in recipes that fetch local or remote files.

.. _ref-varlocality-recipe-dependencies:

Dependencies
------------

This section lists variables that define recipe dependencies.

-  :term:`DEPENDS`

-  :term:`RDEPENDS`

-  :term:`RRECOMMENDS`

-  :term:`RCONFLICTS`

-  :term:`RREPLACES`

.. _ref-varlocality-recipe-paths:

Paths
-----

This section lists variables that define recipe paths.

-  :term:`WORKDIR`

-  :term:`S`

-  :term:`FILES`

.. _ref-varlocality-recipe-build:

Extra Build Information
-----------------------

This section lists variables that define extra build information for
recipes.

-  :term:`DEFAULT_PREFERENCE`

-  :term:`EXTRA_OECMAKE`

-  :term:`EXTRA_OECONF`

-  :term:`EXTRA_OEMAKE`

-  :term:`PACKAGECONFIG_CONFARGS`

-  :term:`PACKAGES`