summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--documentation/poky-ref-manual/ref-varlocality.xml376
1 files changed, 185 insertions, 191 deletions
diff --git a/documentation/poky-ref-manual/ref-varlocality.xml b/documentation/poky-ref-manual/ref-varlocality.xml
index 21930bf8b6..d3d931b4d0 100644
--- a/documentation/poky-ref-manual/ref-varlocality.xml
+++ b/documentation/poky-ref-manual/ref-varlocality.xml
@@ -2,208 +2,202 @@
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3 3
4<appendix id='ref-varlocality'> 4<appendix id='ref-varlocality'>
5 <title>Reference: Variable Locality (Distro, Machine, Recipe etc.)</title> 5 <title>Reference: Variable Context</title>
6 6
7 <para> 7 <para>
8 Whilst most variables can be used in almost any context (.conf, .bbclass, 8 While most variables can be used in almost any context such as
9 .inc or .bb file), variables are often associated with a particular 9 <filename>.conf</filename>, <filename>.bbclass</filename>,
10 locality/context. This section describes some common associations. 10 <filename>.inc</filename>, and <filename>.bb</filename> files,
11 some variables are often associated with a particular locality or context.
12 This appendix describes some common associations.
11 </para> 13 </para>
12 14
13 <section id='ref-varlocality-config-distro'> 15 <section id='ref-varlocality-configuration'>
14 <title>Distro Configuration</title> 16 <title>Configuration</title>
15
16 <itemizedlist>
17 <listitem>
18 <para><glossterm linkend='var-DISTRO'><link linkend='var-DISTRO'>DISTRO</link></glossterm></para>
19 </listitem>
20 <listitem>
21 <para><glossterm linkend='var-DISTRO_NAME'><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></glossterm></para>
22 </listitem>
23 <listitem>
24 <para><glossterm linkend='var-DISTRO_VERSION'><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link></glossterm></para>
25 </listitem>
26 <listitem>
27 <para><glossterm linkend='var-MAINTAINER'><link linkend='var-MAINTAINER'>MAINTAINER</link></glossterm></para>
28 </listitem>
29 <listitem>
30 <para><glossterm linkend='var-PACKAGE_CLASSES'><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm></para>
31 </listitem>
32 <listitem>
33 <para><glossterm linkend='var-TARGET_OS'><link linkend='var-TARGET_OS'>TARGET_OS</link></glossterm></para>
34 </listitem>
35 <listitem>
36 <para><glossterm linkend='var-TARGET_FPU'><link linkend='var-TARGET_FPU'>TARGET_FPU</link></glossterm></para>
37 </listitem>
38 <listitem>
39 <para><glossterm linkend='var-POKYMODE'><link linkend='var-POKYMODE'>POKYMODE</link></glossterm></para>
40 </listitem>
41 <listitem>
42 <para><glossterm linkend='var-POKYLIBC'><link linkend='var-POKYLIBC'>POKYLIBC</link></glossterm></para>
43 </listitem>
44 </itemizedlist>
45 </section>
46 17
47 <section id='ref-varlocality-config-machine'> 18 <para>
48 <title>Machine Configuration</title> 19 The following subsections provide lists of variables whose context is
49 20 configuration: distribution, machine, and local.
50 <itemizedlist> 21 </para>
51 <listitem>
52 <para><glossterm linkend='var-TARGET_ARCH'><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></glossterm></para>
53 </listitem>
54 <listitem>
55 <para><glossterm linkend='var-SERIAL_CONSOLE'><link linkend='var-SERIAL_CONSOLE'>SERIAL_CONSOLE</link></glossterm></para>
56 </listitem>
57 <listitem>
58 <para><glossterm linkend='var-PACKAGE_EXTRA_ARCHS'><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link></glossterm></para>
59 </listitem>
60 <listitem>
61 <para><glossterm linkend='var-IMAGE_FSTYPES'><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></glossterm></para>
62 </listitem>
63 <listitem>
64 <para><glossterm linkend='var-ROOT_FLASH_SIZE'><link linkend='var-ROOT_FLASH_SIZE'>ROOT_FLASH_SIZE</link></glossterm></para>
65 </listitem>
66 <listitem>
67 <para><glossterm linkend='var-MACHINE_FEATURES'><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></glossterm></para>
68 </listitem>
69 <listitem>
70 <para><glossterm linkend='var-MACHINE_EXTRA_RDEPENDS'><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></glossterm></para>
71 </listitem>
72 <listitem>
73 <para><glossterm linkend='var-MACHINE_EXTRA_RRECOMMENDS'><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></glossterm></para>
74 </listitem>
75 <listitem>
76 <para><glossterm linkend='var-MACHINE_ESSENTIAL_RDEPENDS'><link linkend='var-MACHINE_ESSENTIAL_RDEPENDS'>MACHINE_ESSENTIAL_RDEPENDS</link></glossterm></para>
77 </listitem>
78 <listitem>
79 <para><glossterm linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'><link linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'>MACHINE_ESSENTIAL_RRECOMMENDS</link></glossterm></para>
80 </listitem>
81 </itemizedlist>
82 </section>
83 22
84 <section id='ref-varlocality-config-local'> 23 <section id='ref-varlocality-config-distro'>
85 <title>Local Configuration (local.conf)</title> 24 <title>Distribution (Distro)</title>
86 <itemizedlist>
87 <listitem>
88 <para><glossterm linkend='var-DISTRO'><link linkend='var-DISTRO'>DISTRO</link></glossterm></para>
89 </listitem>
90 <listitem>
91 <para><glossterm linkend='var-MACHINE'><link linkend='var-MACHINE'>MACHINE</link></glossterm></para>
92 </listitem>
93 <listitem>
94 <para><glossterm linkend='var-DL_DIR'><link linkend='var-DL_DIR'>DL_DIR</link></glossterm></para>
95 </listitem>
96 <listitem>
97 <para><glossterm linkend='var-BBFILES'><link linkend='var-BBFILES'>BBFILES</link></glossterm></para>
98 </listitem>
99 <listitem>
100 <para><glossterm linkend='var-EXTRA_IMAGE_FEATURES'><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></glossterm></para>
101 </listitem>
102 <listitem>
103 <para><glossterm linkend='var-PACKAGE_CLASSES'><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm></para>
104 </listitem>
105 <listitem>
106 <para><glossterm linkend='var-BB_NUMBER_THREADS'><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link></glossterm></para>
107 </listitem>
108 <listitem>
109 <para><glossterm linkend='var-BBINCLUDELOGS'><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link></glossterm></para>
110 </listitem>
111 <listitem>
112 <para><glossterm linkend='var-ENABLE_BINARY_LOCALE_GENERATION'><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>ENABLE_BINARY_LOCALE_GENERATION</link></glossterm></para>
113 </listitem>
114 </itemizedlist>
115 </section>
116 25
117 <section id='ref-varlocality-recipe-required'> 26 <para>
118 <title>Recipe Variables - Required</title> 27 This section lists variables whose context is the distribution, or distro.
119 28 <itemizedlist>
120 <itemizedlist> 29 <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename></para></listitem>
121 <listitem> 30 <listitem><para><filename><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></filename>
122 <para><glossterm><link linkend='var-DESCRIPTION'>DESCRIPTION</link></glossterm></para> 31 </para></listitem>
123 </listitem> 32 <listitem><para><filename><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link>
124 <listitem> 33 </filename></para></listitem>
125 <para><glossterm><link linkend='var-LICENSE'>LICENSE</link></glossterm></para> 34 <listitem><para><filename><link linkend='var-MAINTAINER'>MAINTAINER</link></filename>
126 </listitem> 35 </para></listitem>
127 <listitem> 36 <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
128 <para><glossterm><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></glossterm></para> 37 </filename></para></listitem>
129 </listitem> 38 <listitem><para><filename><link linkend='var-TARGET_OS'>TARGET_OS</link></filename>
130 <listitem> 39 </para></listitem>
131 <para><glossterm><link linkend='var-SECTION'>SECTION</link></glossterm></para> 40 <listitem><para><filename><link linkend='var-TARGET_FPU'>TARGET_FPU</link></filename>
132 </listitem> 41 </para></listitem>
133 <listitem> 42 <listitem><para><filename><link linkend='var-POKYMODE'>POKYMODE</link></filename>
134 <para><glossterm><link linkend='var-HOMEPAGE'>HOMEPAGE</link></glossterm></para> 43 </para></listitem>
135 </listitem> 44 <listitem><para><filename><link linkend='var-TCMODE'>TCMODE</link></filename>
136 <listitem> 45 </para></listitem>
137 <para><glossterm><link linkend='var-AUTHOR'>AUTHOR</link></glossterm></para> 46 <listitem><para><filename><link linkend='var-POKYLIBC'>POKYLIBC</link></filename>
138 </listitem> 47 </para></listitem>
139 <listitem> 48 </itemizedlist>
140 <para><glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm></para> 49 </para>
141 </listitem> 50 </section>
142 </itemizedlist>
143 </section>
144 51
145 <section id='ref-varlocality-recipe-dependencies'> 52 <section id='ref-varlocality-config-machine'>
146 <title>Recipe Variables - Dependencies</title> 53 <title>Machine</title>
147 54
148 <itemizedlist> 55 <para>
149 <listitem> 56 This section lists variables whose context is the machine.
150 <para><glossterm><link linkend='var-DEPENDS'>DEPENDS</link></glossterm></para> 57 <itemizedlist>
151 </listitem> 58 <listitem><para><filename><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></filename>
152 <listitem> 59 </para></listitem>
153 <para><glossterm><link linkend='var-RDEPENDS'>RDEPENDS</link></glossterm></para> 60 <listitem><para><filename><link linkend='var-SERIAL_CONSOLE'>SERIAL_CONSOLE</link>
154 </listitem> 61 </filename></para></listitem>
155 <listitem> 62 <listitem><para><filename><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link>
156 <para><glossterm><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link></glossterm></para> 63 </filename></para></listitem>
157 </listitem> 64 <listitem><para><filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link>
158 <listitem> 65 </filename></para></listitem>
159 <para><glossterm><link linkend='var-RCONFLICTS'>RCONFLICTS</link></glossterm></para> 66 <listitem><para><filename><link linkend='var-ROOT_FLASH_SIZE'>ROOT_FLASH_SIZE</link>
160 </listitem> 67 </filename></para></listitem>
161 <listitem> 68 <listitem><para><filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link>
162 <para><glossterm><link linkend='var-RREPLACES'>RREPLACES</link></glossterm></para> 69 </filename></para></listitem>
163 </listitem> 70 <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS
164 </itemizedlist> 71 </link></filename></para></listitem>
165 </section> 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_RDEPENDS'>MACHINE_ESSENTIAL_RDEPENDS
75 </link></filename></para></listitem>
76 <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'>
77 MACHINE_ESSENTIAL_RRECOMMENDS</link></filename></para></listitem>
78 </itemizedlist>
79 </para>
80 </section>
166 81
167 <section id='ref-varlocality-recipe-paths'> 82 <section id='ref-varlocality-config-local'>
168 <title>Recipe Variables - Paths</title> 83 <title>Local</title>
169 84
170 <itemizedlist> 85 <para>
171 <listitem> 86 This section lists variables whose context is the local configuration through the
172 <para><glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm></para> 87 <filename>local.conf</filename> file.
173 </listitem> 88 <itemizedlist>
174 <listitem> 89 <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename>
175 <para><glossterm><link linkend='var-S'>S</link></glossterm></para> 90 </para></listitem>
176 </listitem> 91 <listitem><para><filename><link linkend='var-MACHINE'>MACHINE</link></filename>
177 <listitem> 92 </para></listitem>
178 <para><glossterm><link linkend='var-FILES'>FILES</link></glossterm></para> 93 <listitem><para><filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>
179 </listitem> 94 </para></listitem>
180 </itemizedlist> 95 <listitem><para><filename><link linkend='var-BBFILES'>BBFILES</link></filename>
96 </para></listitem>
97 <listitem><para><filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES
98 </link></filename></para></listitem>
99 <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
100 </filename></para></listitem>
101 <listitem><para><filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link>
102 </filename></para></listitem>
103 <listitem><para><filename><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link>
104 </filename></para></listitem>
105 <listitem><para><filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>
106 ENABLE_BINARY_LOCALE_GENERATION</link></filename></para></listitem>
107 </itemizedlist>
108 </para>
109 </section>
181 </section> 110 </section>
182 111
183 <section id='ref-varlocality-recipe-build'> 112 <section id='ref-varlocality-recipes'>
184 <title>Recipe Variables - Extra Build Information</title> 113 <title>Recipes</title>
185 114
186 <itemizedlist> 115 <para>
187 <listitem> 116 The following subsections provide lists of variables whose context is
188 <para><glossterm><link 117 recipes: required, dependencies, path, and extra build information.
189 linkend='var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</link></glossterm></para> 118 </para>
190 </listitem> 119
191 <listitem> 120 <section id='ref-varlocality-recipe-required'>
192 <para><glossterm><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link></glossterm></para> 121 <title>Required</title>
193 </listitem> 122
194 <listitem> 123 <para>
195 <para><glossterm><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></glossterm></para> 124 This section lists variables that are required for recipes.
196 </listitem> 125 <itemizedlist>
197 <listitem> 126 <listitem><para><filename><link linkend='var-DESCRIPTION'>DESCRIPTION</link>
198 <para><glossterm><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></glossterm></para> 127 </filename></para></listitem>
199 </listitem> 128 <listitem><para><filename><link linkend='var-LICENSE'>LICENSE</link>
200 <listitem> 129 </filename></para></listitem>
201 <para><glossterm><link linkend='var-PACKAGES'>PACKAGES</link></glossterm></para> 130 <listitem><para><filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link>
202 </listitem> 131 </filename></para></listitem>
203 <listitem> 132 <listitem><para><filename><link linkend='var-SECTION'>SECTION</link>
204 <para><glossterm><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE</link></glossterm></para> 133 </filename></para></listitem>
205 </listitem> 134 <listitem><para><filename><link linkend='var-HOMEPAGE'>HOMEPAGE</link>
206 </itemizedlist> 135 </filename></para></listitem>
136 <listitem><para><filename><link linkend='var-AUTHOR'>AUTHOR</link>
137 </filename></para></listitem>
138 <listitem><para><filename><link linkend='var-SRC_URI'>SRC_URI</link>
139 </filename></para></listitem>
140 </itemizedlist>
141 </para>
142 </section>
143
144 <section id='ref-varlocality-recipe-dependencies'>
145 <title>Dependencies</title>
146
147 <para>
148 This section lists variables that define recipe dependencies.
149 <itemizedlist>
150 <listitem><para><filename><link linkend='var-DEPENDS'>DEPENDS</link>
151 </filename></para></listitem>
152 <listitem><para><filename><link linkend='var-RDEPENDS'>RDEPENDS</link>
153 </filename></para></listitem>
154 <listitem><para><filename><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link>
155 </filename></para></listitem>
156 <listitem><para><filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link>
157 </filename></para></listitem>
158 <listitem><para><filename><link linkend='var-RREPLACES'>RREPLACES</link>
159 </filename></para></listitem>
160 </itemizedlist>
161 </para>
162 </section>
163
164 <section id='ref-varlocality-recipe-paths'>
165 <title>Paths</title>
166
167 <para>
168 This section lists variables that define recipe paths.
169 <itemizedlist>
170 <listitem><para><filename><link linkend='var-WORKDIR'>WORKDIR</link>
171 </filename></para></listitem>
172 <listitem><para><filename><link linkend='var-S'>S</link>
173 </filename></para></listitem>
174 <listitem><para><filename><link linkend='var-FILES'>FILES</link>
175 </filename></para></listitem>
176 </itemizedlist>
177 </para>
178 </section>
179
180 <section id='ref-varlocality-recipe-build'>
181 <title>Extra Build Information</title>
182
183 <para>
184 This section lists variables that define extra build information for recipes.
185 <itemizedlist>
186 <listitem><para><filename><link linkend='var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</link>
187 </filename></para></listitem>
188 <listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link>
189 </filename></para></listitem>
190 <listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link>
191 </filename></para></listitem>
192 <listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link>
193 </filename></para></listitem>
194 <listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
195 </para></listitem>
196 <listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE
197 </link></filename></para></listitem>
198 </itemizedlist>
199 </para>
200 </section>
207 </section> 201 </section>
208</appendix> 202</appendix>
209<!-- 203<!--
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-01-10 16:15:06 +0000