Gitiles
Code Review Sign In
gerrit.openbmc.org / stefanberger / openbmc / 4873add6e11c1bd421c83cd08df589f1184aa673 / . / poky / documentation / ref-manual / ref-varlocality.xml
blob: a2436fb310e84ad1f5f9428463e822685b5d1d1a [file] [log] [blame]
Andrew Geissler4873add2020-11-02 18:44:49 -0600[diff] [blame^]1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
5
6<chapter id='ref-varlocality'>
7 <title>Variable Context</title>
8
9 <para>
10 While you can use most variables in almost any context such as
11 <filename>.conf</filename>, <filename>.bbclass</filename>,
12 <filename>.inc</filename>, and <filename>.bb</filename> files,
13 some variables are often associated with a particular locality or context.
14 This chapter describes some common associations.
15 </para>
16
17 <section id='ref-varlocality-configuration'>
18 <title>Configuration</title>
19
20 <para>
21 The following subsections provide lists of variables whose context is
22 configuration: distribution, machine, and local.
23 </para>
24
25 <section id='ref-varlocality-config-distro'>
26 <title>Distribution (Distro)</title>
27
28 <para>
29 This section lists variables whose configuration context is the
30 distribution, or distro.
31 <itemizedlist>
32 <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename></para></listitem>
33 <listitem><para><filename><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></filename>
34 </para></listitem>
35 <listitem><para><filename><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link>
36 </filename></para></listitem>
37 <listitem><para><filename><link linkend='var-MAINTAINER'>MAINTAINER</link></filename>
38 </para></listitem>
39 <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
40 </filename></para></listitem>
41 <listitem><para><filename><link linkend='var-TARGET_OS'>TARGET_OS</link></filename>
42 </para></listitem>
43 <listitem><para><filename><link linkend='var-TARGET_FPU'>TARGET_FPU</link></filename>
44 </para></listitem>
45 <listitem><para><filename><link linkend='var-TCMODE'>TCMODE</link></filename>
46 </para></listitem>
47 <listitem><para><filename><link linkend='var-TCLIBC'>TCLIBC</link></filename>
48 </para></listitem>
49 </itemizedlist>
50 </para>
51 </section>
52
53 <section id='ref-varlocality-config-machine'>
54 <title>Machine</title>
55
56 <para>
57 This section lists variables whose configuration context is the
58 machine.
59 <itemizedlist>
60 <listitem><para><filename><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></filename>
61 </para></listitem>
62 <listitem><para><filename><link linkend='var-SERIAL_CONSOLES'>SERIAL_CONSOLES</link>
63 </filename></para></listitem>
64 <listitem><para><filename><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link>
65 </filename></para></listitem>
66 <listitem><para><filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link>
67 </filename></para></listitem>
68 <listitem><para><filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link>
69 </filename></para></listitem>
70 <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS
71 </link></filename></para></listitem>
72 <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS
73 </link></filename></para></listitem>
74 <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS
75 </link></filename></para></listitem>
76 <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>
77 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename></para></listitem>
78 </itemizedlist>
79 </para>
80 </section>
81
82 <section id='ref-varlocality-config-local'>
83 <title>Local</title>
84
85 <para>
86 This section lists variables whose configuration context is the
87 local configuration through the <filename>local.conf</filename>
88 file.
89 <itemizedlist>
90 <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename>
91 </para></listitem>
92 <listitem><para><filename><link linkend='var-MACHINE'>MACHINE</link></filename>
93 </para></listitem>
94 <listitem><para><filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>
95 </para></listitem>
96 <listitem><para><filename><link linkend='var-BBFILES'>BBFILES</link></filename>
97 </para></listitem>
98 <listitem><para><filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES
99 </link></filename></para></listitem>
100 <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
101 </filename></para></listitem>
102 <listitem><para><filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link>
103 </filename></para></listitem>
104 <listitem><para><filename><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link>
105 </filename></para></listitem>
106 <listitem><para><filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>
107 ENABLE_BINARY_LOCALE_GENERATION</link></filename></para></listitem>
108 </itemizedlist>
109 </para>
110 </section>
111 </section>
112
113 <section id='ref-varlocality-recipes'>
114 <title>Recipes</title>
115
116 <para>
117 The following subsections provide lists of variables whose context is
118 recipes: required, dependencies, path, and extra build information.
119 </para>
120
121 <section id='ref-varlocality-recipe-required'>
122 <title>Required</title>
123
124 <para>
125 This section lists variables that are required for recipes.
126 <itemizedlist>
127 <listitem><para><filename><link linkend='var-LICENSE'>LICENSE</link>
128 </filename></para></listitem>
129 <listitem><para><filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link>
130 </filename></para></listitem>
131 <listitem><para><filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> - used
132 in recipes that fetch local or remote files.
133 </para></listitem>
134 </itemizedlist>
135 </para>
136 </section>
137
138 <section id='ref-varlocality-recipe-dependencies'>
139 <title>Dependencies</title>
140
141 <para>
142 This section lists variables that define recipe dependencies.
143 <itemizedlist>
144 <listitem><para><filename><link linkend='var-DEPENDS'>DEPENDS</link>
145 </filename></para></listitem>
146 <listitem><para><filename><link linkend='var-RDEPENDS'>RDEPENDS</link>
147 </filename></para></listitem>
148 <listitem><para><filename><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link>
149 </filename></para></listitem>
150 <listitem><para><filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link>
151 </filename></para></listitem>
152 <listitem><para><filename><link linkend='var-RREPLACES'>RREPLACES</link>
153 </filename></para></listitem>
154 </itemizedlist>
155 </para>
156 </section>
157
158 <section id='ref-varlocality-recipe-paths'>
159 <title>Paths</title>
160
161 <para>
162 This section lists variables that define recipe paths.
163 <itemizedlist>
164 <listitem><para><filename><link linkend='var-WORKDIR'>WORKDIR</link>
165 </filename></para></listitem>
166 <listitem><para><filename><link linkend='var-S'>S</link>
167 </filename></para></listitem>
168 <listitem><para><filename><link linkend='var-FILES'>FILES</link>
169 </filename></para></listitem>
170 </itemizedlist>
171 </para>
172 </section>
173
174 <section id='ref-varlocality-recipe-build'>
175 <title>Extra Build Information</title>
176
177 <para>
178 This section lists variables that define extra build information for recipes.
179 <itemizedlist>
180 <listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE
181 </link></filename></para></listitem>
182 <listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link>
183 </filename></para></listitem>
184 <listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link>
185 </filename></para></listitem>
186 <listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link>
187 </filename></para></listitem>
188 <listitem><para><filename><link linkend='var-PACKAGECONFIG_CONFARGS'>PACKAGECONFIG_CONFARGS</link>
189 </filename></para></listitem>
190 <listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
191 </para></listitem>
192 </itemizedlist>
193 </para>
194 </section>
195 </section>
196</chapter>
197<!--
198vim: expandtab tw=80 ts=4 spell spelllang=en_gb
199-->