summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-varlocality.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-12-11 12:07:58 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-07 14:43:25 +0000
commited0a240e1632682ec4c33341f3e24ad71773cdfc (patch)
tree201557f498b77b9f51fad7e12a6009f74aca4c65 /documentation/ref-manual/ref-varlocality.xml
parentaf19d889ef320f9625aae42eed6688b5cc739793 (diff)
downloadpoky-ed0a240e1632682ec4c33341f3e24ad71773cdfc.tar.gz
documentation: Rename of poky-ref-manual folder to ref-manual.
Changing the folder that holds the YP Reference Manual to be "ref-manual". This will help with confustion over the manual's intended purpose. (From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-varlocality.xml')
-rw-r--r--documentation/ref-manual/ref-varlocality.xml193
1 files changed, 193 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-varlocality.xml b/documentation/ref-manual/ref-varlocality.xml
new file mode 100644
index 0000000000..ae8f75c2f5
--- /dev/null
+++ b/documentation/ref-manual/ref-varlocality.xml
@@ -0,0 +1,193 @@
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
5<chapter id='ref-varlocality'>
6 <title>Variable Context</title>
7
8 <para>
9 While most variables can be used in almost any context such as
10 <filename>.conf</filename>, <filename>.bbclass</filename>,
11 <filename>.inc</filename>, and <filename>.bb</filename> files,
12 some variables are often associated with a particular locality or context.
13 This chapter describes some common associations.
14 </para>
15
16 <section id='ref-varlocality-configuration'>
17 <title>Configuration</title>
18
19 <para>
20 The following subsections provide lists of variables whose context is
21 configuration: distribution, machine, and local.
22 </para>
23
24 <section id='ref-varlocality-config-distro'>
25 <title>Distribution (Distro)</title>
26
27 <para>
28 This section lists variables whose context is the distribution, or distro.
29 <itemizedlist>
30 <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename></para></listitem>
31 <listitem><para><filename><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></filename>
32 </para></listitem>
33 <listitem><para><filename><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link>
34 </filename></para></listitem>
35 <listitem><para><filename><link linkend='var-MAINTAINER'>MAINTAINER</link></filename>
36 </para></listitem>
37 <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
38 </filename></para></listitem>
39 <listitem><para><filename><link linkend='var-TARGET_OS'>TARGET_OS</link></filename>
40 </para></listitem>
41 <listitem><para><filename><link linkend='var-TARGET_FPU'>TARGET_FPU</link></filename>
42 </para></listitem>
43 <listitem><para><filename><link linkend='var-TCMODE'>TCMODE</link></filename>
44 </para></listitem>
45 <listitem><para><filename><link linkend='var-TCLIBC'>TCLIBC</link></filename>
46 </para></listitem>
47 </itemizedlist>
48 </para>
49 </section>
50
51 <section id='ref-varlocality-config-machine'>
52 <title>Machine</title>
53
54 <para>
55 This section lists variables whose context is the machine.
56 <itemizedlist>
57 <listitem><para><filename><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></filename>
58 </para></listitem>
59 <listitem><para><filename><link linkend='var-SERIAL_CONSOLE'>SERIAL_CONSOLE</link>
60 </filename></para></listitem>
61 <listitem><para><filename><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link>
62 </filename></para></listitem>
63 <listitem><para><filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link>
64 </filename></para></listitem>
65 <listitem><para><filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link>
66 </filename></para></listitem>
67 <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS
68 </link></filename></para></listitem>
69 <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS
70 </link></filename></para></listitem>
71 <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS
72 </link></filename></para></listitem>
73 <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>
74 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename></para></listitem>
75 </itemizedlist>
76 </para>
77 </section>
78
79 <section id='ref-varlocality-config-local'>
80 <title>Local</title>
81
82 <para>
83 This section lists variables whose context is the local configuration through the
84 <filename>local.conf</filename> file.
85 <itemizedlist>
86 <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename>
87 </para></listitem>
88 <listitem><para><filename><link linkend='var-MACHINE'>MACHINE</link></filename>
89 </para></listitem>
90 <listitem><para><filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>
91 </para></listitem>
92 <listitem><para><filename><link linkend='var-BBFILES'>BBFILES</link></filename>
93 </para></listitem>
94 <listitem><para><filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES
95 </link></filename></para></listitem>
96 <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
97 </filename></para></listitem>
98 <listitem><para><filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link>
99 </filename></para></listitem>
100 <listitem><para><filename><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link>
101 </filename></para></listitem>
102 <listitem><para><filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>
103 ENABLE_BINARY_LOCALE_GENERATION</link></filename></para></listitem>
104 </itemizedlist>
105 </para>
106 </section>
107 </section>
108
109 <section id='ref-varlocality-recipes'>
110 <title>Recipes</title>
111
112 <para>
113 The following subsections provide lists of variables whose context is
114 recipes: required, dependencies, path, and extra build information.
115 </para>
116
117 <section id='ref-varlocality-recipe-required'>
118 <title>Required</title>
119
120 <para>
121 This section lists variables that are required for recipes.
122 <itemizedlist>
123 <listitem><para><filename><link linkend='var-LICENSE'>LICENSE</link>
124 </filename></para></listitem>
125 <listitem><para><filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link>
126 </filename></para></listitem>
127 <listitem><para><filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> - used
128 in recipes that fetch local or remote files.
129 </para></listitem>
130 </itemizedlist>
131 </para>
132 </section>
133
134 <section id='ref-varlocality-recipe-dependencies'>
135 <title>Dependencies</title>
136
137 <para>
138 This section lists variables that define recipe dependencies.
139 <itemizedlist>
140 <listitem><para><filename><link linkend='var-DEPENDS'>DEPENDS</link>
141 </filename></para></listitem>
142 <listitem><para><filename><link linkend='var-RDEPENDS'>RDEPENDS</link>
143 </filename></para></listitem>
144 <listitem><para><filename><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link>
145 </filename></para></listitem>
146 <listitem><para><filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link>
147 </filename></para></listitem>
148 <listitem><para><filename><link linkend='var-RREPLACES'>RREPLACES</link>
149 </filename></para></listitem>
150 </itemizedlist>
151 </para>
152 </section>
153
154 <section id='ref-varlocality-recipe-paths'>
155 <title>Paths</title>
156
157 <para>
158 This section lists variables that define recipe paths.
159 <itemizedlist>
160 <listitem><para><filename><link linkend='var-WORKDIR'>WORKDIR</link>
161 </filename></para></listitem>
162 <listitem><para><filename><link linkend='var-S'>S</link>
163 </filename></para></listitem>
164 <listitem><para><filename><link linkend='var-FILES'>FILES</link>
165 </filename></para></listitem>
166 </itemizedlist>
167 </para>
168 </section>
169
170 <section id='ref-varlocality-recipe-build'>
171 <title>Extra Build Information</title>
172
173 <para>
174 This section lists variables that define extra build information for recipes.
175 <itemizedlist>
176 <listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link>
177 </filename></para></listitem>
178 <listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link>
179 </filename></para></listitem>
180 <listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link>
181 </filename></para></listitem>
182 <listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
183 </para></listitem>
184 <listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE
185 </link></filename></para></listitem>
186 </itemizedlist>
187 </para>
188 </section>
189 </section>
190</chapter>
191<!--
192vim: expandtab tw=80 ts=4 spell spelllang=en_gb
193-->
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-16 21:43:38 +0000