summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/ref-varlocality.xml
diff options
context:
space:
mode:
authorRichard Purdie <rpurdie@linux.intel.com>2010-10-15 11:55:59 +0100
committerRichard Purdie <rpurdie@linux.intel.com>2010-10-15 11:55:59 +0100
commit22083287912ebd552e33b79f7c567bc966376d43 (patch)
treea16fa012a97a249e25a405d4092b0a89321bfaf6 /documentation/poky-ref-manual/ref-varlocality.xml
parent13a702e9e572a2dc9f6b52a1531a2237d4d98ff1 (diff)
downloadpoky-22083287912ebd552e33b79f7c567bc966376d43.tar.gz
handbook: Move into documentation directory
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
Diffstat (limited to 'documentation/poky-ref-manual/ref-varlocality.xml')
-rw-r--r--documentation/poky-ref-manual/ref-varlocality.xml211
1 files changed, 211 insertions, 0 deletions
diff --git a/documentation/poky-ref-manual/ref-varlocality.xml b/documentation/poky-ref-manual/ref-varlocality.xml
new file mode 100644
index 0000000000..87ef0833d7
--- /dev/null
+++ b/documentation/poky-ref-manual/ref-varlocality.xml
@@ -0,0 +1,211 @@
1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3
4<appendix id='ref-varlocality'>
5 <title>Reference: Variable Locality (Distro, Machine, Recipe etc.)</title>
6
7 <para>
8 Whilst most variables can be used in almost any context (.conf, .bbclass,
9 .inc or .bb file), variables are often associated with a particular
10 locality/context. This section describes some common associations.
11 </para>
12
13 <section id='ref-varlocality-config-distro'>
14 <title>Distro 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
47 <section id='ref-varlocality-config-machine'>
48 <title>Machine Configuration</title>
49
50 <itemizedlist>
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
84 <section id='ref-varlocality-config-local'>
85 <title>Local Configuration (local.conf)</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-IMAGE_FEATURES'><link linkend='var-IMAGE_FEATURES'>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
117 <section id='ref-varlocality-recipe-required'>
118 <title>Recipe Variables - Required</title>
119
120 <itemizedlist>
121 <listitem>
122 <para><glossterm><link linkend='var-DESCRIPTION'>DESCRIPTION</link></glossterm></para>
123 </listitem>
124 <listitem>
125 <para><glossterm><link linkend='var-LICENSE'>LICENSE</link></glossterm></para>
126 </listitem>
127 <listitem>
128 <para><glossterm><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></glossterm></para>
129 </listitem>
130 <listitem>
131 <para><glossterm><link linkend='var-SECTION'>SECTION</link></glossterm></para>
132 </listitem>
133 <listitem>
134 <para><glossterm><link linkend='var-HOMEPAGE'>HOMEPAGE</link></glossterm></para>
135 </listitem>
136 <listitem>
137 <para><glossterm><link linkend='var-AUTHOR'>AUTHOR</link></glossterm></para>
138 </listitem>
139 <listitem>
140 <para><glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm></para>
141 </listitem>
142 </itemizedlist>
143 </section>
144
145 <section id='ref-varlocality-recipe-dependencies'>
146 <title>Recipe Variables - Dependencies</title>
147
148 <itemizedlist>
149 <listitem>
150 <para><glossterm><link linkend='var-DEPENDS'>DEPENDS</link></glossterm></para>
151 </listitem>
152 <listitem>
153 <para><glossterm><link linkend='var-RDEPENDS'>RDEPENDS</link></glossterm></para>
154 </listitem>
155 <listitem>
156 <para><glossterm><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link></glossterm></para>
157 </listitem>
158 <listitem>
159 <para><glossterm><link linkend='var-RCONFLICTS'>RCONFLICTS</link></glossterm></para>
160 </listitem>
161 <listitem>
162 <para><glossterm><link linkend='var-RREPLACES'>RREPLACES</link></glossterm></para>
163 </listitem>
164 </itemizedlist>
165 </section>
166
167 <section id='ref-varlocality-recipe-paths'>
168 <title>Recipe Variables - Paths</title>
169
170 <itemizedlist>
171 <listitem>
172 <para><glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm></para>
173 </listitem>
174 <listitem>
175 <para><glossterm><link linkend='var-S'>S</link></glossterm></para>
176 </listitem>
177 <listitem>
178 <para><glossterm><link linkend='var-FILES'>FILES</link></glossterm></para>
179 </listitem>
180 </itemizedlist>
181 </section>
182
183 <section id='ref-varlocality-recipe-build'>
184 <title>Recipe Variables - Extra Build Information</title>
185
186 <itemizedlist>
187 <listitem>
188 <para><glossterm><link
189 linkend='var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</link></glossterm></para>
190 </listitem>
191 <listitem>
192 <para><glossterm><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link></glossterm></para>
193 </listitem>
194 <listitem>
195 <para><glossterm><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></glossterm></para>
196 </listitem>
197 <listitem>
198 <para><glossterm><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></glossterm></para>
199 </listitem>
200 <listitem>
201 <para><glossterm><link linkend='var-PACKAGES'>PACKAGES</link></glossterm></para>
202 </listitem>
203 <listitem>
204 <para><glossterm><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE</link></glossterm></para>
205 </listitem>
206 </itemizedlist>
207 </section>
208</appendix>
209<!--
210vim: expandtab tw=80 ts=4 spell spelllang=en_gb
211-->
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-16 06:26:53 +0000