summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-04-04 17:49:11 -0500
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-04-06 08:01:21 -0700
commitcb2a3e32d7a0497c385aa1e79176d85769d6e31a (patch)
tree739e8c109b6d82bbf3fbbaf8cabb3ec168a8bcc2 /documentation/poky-ref-manual
parent72d7e273519f53464a4b85466680f45efa1eb537 (diff)
downloadpoky-cb2a3e32d7a0497c385aa1e79176d85769d6e31a.tar.gz
documentation/poky-ref-manual/ref-structure.xml: Edits for Rel 1.0
These edits reflect changes in the directory structure from the 0.9 version of the software to the 1.0 version. This set of changes still is missing a few items. Changes were based on Saul Wold's input. (From OE-Core rev: 6288e2af1b05d849e53b90071c66bc893ba015b6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual')
-rw-r--r--documentation/poky-ref-manual/ref-structure.xml103
1 files changed, 97 insertions, 6 deletions
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml
index 7ebf9bddbf..4cfd08fae6 100644
--- a/documentation/poky-ref-manual/ref-structure.xml
+++ b/documentation/poky-ref-manual/ref-structure.xml
@@ -61,7 +61,7 @@
61 </para> 61 </para>
62 </section> 62 </section>
63 63
64 <section id='structure-core-meta-extras'> 64<!-- <section id='structure-core-meta-extras'>
65 <title><filename class="directory">meta-extras/</filename></title> 65 <title><filename class="directory">meta-extras/</filename></title>
66 66
67 <para> 67 <para>
@@ -70,8 +70,25 @@
70 This metadata is disabled by default and is not supported as part of Poky. 70 This metadata is disabled by default and is not supported as part of Poky.
71 </para> 71 </para>
72 </section> 72 </section>
73-->
74
75 <section id='structure-core-meta-demoapps'>
76 <title><filename class="directory">meta-demoapps/</filename></title>
77
78 <para>
79 This directory contains recipes for applications and demos that are not core.
80 </para>
81 </section>
82
83 <section id='structure-core-meta-rt'>
84 <title><filename class="directory">meta-rt/</filename></title>
73 85
74 <section id='structure-core-meta-***'> 86 <para>
87 This directory contains recipes for RealTime.
88 </para>
89 </section>
90
91<!-- <section id='structure-core-meta-***'>
75 <title><filename class="directory">meta-***/</filename></title> 92 <title><filename class="directory">meta-***/</filename></title>
76 93
77 <para> 94 <para>
@@ -79,6 +96,7 @@
79 The layers are enabled by adding them to the <filename>conf/bblayers.conf</filename> file. 96 The layers are enabled by adding them to the <filename>conf/bblayers.conf</filename> file.
80 </para> 97 </para>
81 </section> 98 </section>
99-->
82 100
83 <section id='structure-core-scripts'> 101 <section id='structure-core-scripts'>
84 <title><filename class="directory">scripts/</filename></title> 102 <title><filename class="directory">scripts/</filename></title>
@@ -91,7 +109,7 @@
91 </para> 109 </para>
92 </section> 110 </section>
93 111
94 <section id='structure-core-sources'> 112<!-- <section id='structure-core-sources'>
95 <title><filename class="directory">sources/</filename></title> 113 <title><filename class="directory">sources/</filename></title>
96 114
97 <para> 115 <para>
@@ -123,6 +141,7 @@
123 <filename class="extension">.md5</filename> file as well. 141 <filename class="extension">.md5</filename> file as well.
124 </para> 142 </para>
125 </section> 143 </section>
144-->
126 145
127 <section id='handbook'> 146 <section id='handbook'>
128 <title><filename class="directory">documentation</filename></title> 147 <title><filename class="directory">documentation</filename></title>
@@ -159,11 +178,28 @@
159 like Poky to generate the build output. 178 like Poky to generate the build output.
160 </para> 179 </para>
161 </section> 180 </section>
181
182 <section id='structure-basic-top-level'>
183 <title><filename>LICENSE, README, and README.hardware</filename></title>
184
185 <para>
186 These files are standard top-level files.
187 </para>
188 </section>
162</section> 189</section>
163 190
164<section id='structure-build'> 191<section id='structure-build'>
165 <title>The Build Directory - <filename class="directory">build/</filename></title> 192 <title>The Build Directory - <filename class="directory">build/</filename></title>
166 193
194 <section id='structure-build-pseudodone'>
195 <title><filename>build/pseudodone</filename></title>
196
197 <para>
198 This tag file indicates that the intitial pseudo binar was created.
199 The first time BitBake is invoked this file is built.
200 </para>
201 </section>
202
167 <section id='structure-build-conf-local.conf'> 203 <section id='structure-build-conf-local.conf'>
168 <title><filename>build/conf/local.conf</filename></title> 204 <title><filename>build/conf/local.conf</filename></title>
169 205
@@ -197,6 +233,36 @@
197 </para> 233 </para>
198 </section> 234 </section>
199 235
236 <section id='structure-build-conf-sanity_info'>
237 <title><filename>build/conf/sanity_info</filename></title>
238
239 <para>
240 This file is created during the build to indicate the state of the sanity checks.
241 </para>
242 </section>
243
244 <section id='structure-build-downloads'>
245 <title><filename>build/downloads/</filename></title>
246
247 <para>
248 This directory is used for the upstream source tarballs.
249 The directory can be reused by multiple builds or moved to another location.
250 You can control the location of this directory through the
251 <glossterm><link linkend='var-DL_DIR'>DL_DIR</link></glossterm> variable.
252 </para>
253 </section>
254
255 <section id='structure-build-sstate-cache'>
256 <title><filename>build/sstate-cache/</filename></title>
257
258 <para>
259 This directory is used for the shared state cache.
260 The directory can be reused by multiple builds or moved to another location.
261 You can control the location of this directory through the
262 <glossterm><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></glossterm> variable.
263 </para>
264 </section>
265
200 <section id='structure-build-tmp'> 266 <section id='structure-build-tmp'>
201 <title><filename class="directory">build/tmp/</filename></title> 267 <title><filename class="directory">build/tmp/</filename></title>
202 268
@@ -210,6 +276,14 @@
210 </para> 276 </para>
211 </section> 277 </section>
212 278
279 <section id='structure-build-tmp-buildstats'>
280 <title><filename class="directory">build/tmp/buildstats/</filename></title>
281
282 <para>
283 This directory stores the build statistics.
284 </para>
285 </section>
286
213 <section id='structure-build-tmp-cache'> 287 <section id='structure-build-tmp-cache'>
214 <title><filename class="directory">build/tmp/cache/</filename></title> 288 <title><filename class="directory">build/tmp/cache/</filename></title>
215 289
@@ -230,7 +304,7 @@
230 <title><filename class="directory">build/tmp/deploy/deb/</filename></title> 304 <title><filename class="directory">build/tmp/deploy/deb/</filename></title>
231 305
232 <para> 306 <para>
233 This directory receives any .deb packages produced by Poky. 307 This directory receives any <filename>.deb</filename> packages produced by Poky.
234 The packages are sorted into feeds for different architecture types. 308 The packages are sorted into feeds for different architecture types.
235 </para> 309 </para>
236 </section> 310 </section>
@@ -239,7 +313,7 @@
239 <title><filename class="directory">build/tmp/deploy/rpm/</filename></title> 313 <title><filename class="directory">build/tmp/deploy/rpm/</filename></title>
240 314
241 <para> 315 <para>
242 This directory receives any .rpm packages produced by Poky. 316 This directory receives any <filename>.rpm</filename> packages produced by Poky.
243 The packages re sorted into feeds for different architecture types. 317 The packages re sorted into feeds for different architecture types.
244 </para> 318 </para>
245 </section> 319 </section>
@@ -256,7 +330,7 @@
256 <section id='structure-build-tmp-deploy-ipk'> 330 <section id='structure-build-tmp-deploy-ipk'>
257 <title><filename class="directory">build/tmp/deploy/ipk/</filename></title> 331 <title><filename class="directory">build/tmp/deploy/ipk/</filename></title>
258 332
259 <para>This directory receives .ipk packages produced by Poky.</para> 333 <para>This directory receives <filename>.ipk</filename> packages produced by Poky.</para>
260 </section> 334 </section>
261 335
262 <section id='structure-build-tmp-sysroots'> 336 <section id='structure-build-tmp-sysroots'>
@@ -512,6 +586,15 @@
512 </para> 586 </para>
513 </section> 587 </section>
514 588
589 <section id='structure-meta-recipes-support'>
590 <title><filename class="directory">meta/recipes-support/</filename></title>
591
592 <para>
593 This directory contains recipes that used by other recipes, but that are not directly
594 included in images (i.e. depenendies of other recipes).
595 </para>
596 </section>
597
515 <section id='structure-meta-site'> 598 <section id='structure-meta-site'>
516 <title><filename class="directory">meta/site/</filename></title> 599 <title><filename class="directory">meta/site/</filename></title>
517 600
@@ -522,6 +605,14 @@
522 passed to "autoconf" for the various architectures. 605 passed to "autoconf" for the various architectures.
523 </para> 606 </para>
524 </section> 607 </section>
608
609 <section id='structure-meta-recipes-txt'>
610 <title><filename class="directory">meta/recipes.txt/</filename></title>
611
612 <para>
613 This file is a description of the contents of <filename>recipes-*</filename>.
614 </para>
615 </section>
525</section> 616</section>
526 617
527</appendix> 618</appendix>