ref-manual: Tweaks to the structure chapter.

Significant tweaks:

* removal of (confusing) leading slashes from YP filenames
* deletion of reference to non-existent "build/tmp/pkgdata/"

(From yocto-docs rev: e00776f75c350a51314dcbcd629e307e6026188a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Robert P. J. Day 2013-11-07 10:43:22 -08:00 committed by Richard Purdie
parent fa0e05d28a
commit a665b9b68e
1 changed files with 26 additions and 33 deletions

View File

@ -101,7 +101,7 @@
</section> </section>
<section id='handbook'> <section id='handbook'>
<title><filename>documentation</filename></title> <title><filename>documentation/</filename></title>
<para> <para>
This directory holds the source for the Yocto Project documentation This directory holds the source for the Yocto Project documentation
@ -109,7 +109,7 @@
versions of the manuals. versions of the manuals.
Each manual is contained in a sub-folder. Each manual is contained in a sub-folder.
For example, the files for this manual reside in For example, the files for this manual reside in
<filename>ref-manual</filename>. the <filename>ref-manual/</filename> directory.
</para> </para>
</section> </section>
@ -179,9 +179,9 @@
</para> </para>
<para> <para>
The <filename>scripts</filename> directory has useful scripts that assist contributing The <filename>scripts</filename> directory has useful scripts that assist in contributing
back to the Yocto Project, such as <filename>create_pull_request</filename> and back to the Yocto Project, such as <filename>create-pull-request</filename> and
<filename>send_pull_request</filename>. <filename>send-pull-request</filename>.
</para> </para>
</section> </section>
@ -209,7 +209,8 @@
<para> <para>
By default, running this script without a By default, running this script without a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
argument creates the <filename>build</filename> directory. argument creates the <filename>build</filename> directory
in your current working directory.
If you provide a Build Directory argument when you If you provide a Build Directory argument when you
<filename>source</filename> the script, you direct the OpenEmbedded <filename>source</filename> the script, you direct the OpenEmbedded
build system to create a Build Directory of your choice. build system to create a Build Directory of your choice.
@ -346,7 +347,7 @@
<filename><link linkend='var-MACHINE'>MACHINE</link></filename> <filename><link linkend='var-MACHINE'>MACHINE</link></filename>
for which you want to build, which package types you wish to use for which you want to build, which package types you wish to use
(<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>),
the location from which you want to downloaded files the location from which you want to access downloaded files
(<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>), (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>),
and how you want your host machine to use resources and how you want your host machine to use resources
(<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> (<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>
@ -368,9 +369,9 @@
<para> <para>
The source <filename>local.conf.sample</filename> file used The source <filename>local.conf.sample</filename> file used
depends on the <filename>$TEMPLATECONF</filename> script variable, depends on the <filename>$TEMPLATECONF</filename> script variable,
which defaults to <filename>/meta-yocto/conf</filename> which defaults to <filename>meta-yocto/conf</filename>
when you are building from the Yocto Project development when you are building from the Yocto Project development
environment and defaults to <filename>/meta/conf</filename> when environment and defaults to <filename>meta/conf</filename> when
you are building from the OpenEmbedded Core environment. you are building from the OpenEmbedded Core environment.
Because the script variable points to the source of the Because the script variable points to the source of the
<filename>local.conf.sample</filename> file, this implies that <filename>local.conf.sample</filename> file, this implies that
@ -387,11 +388,11 @@
<note> <note>
You can see how the <filename>TEMPLATECONF</filename> variable You can see how the <filename>TEMPLATECONF</filename> variable
is used by looking at the is used by looking at the
<filename>/scripts/oe-setup-builddir</filename> script in the <filename>scripts/oe-setup-builddir</filename> script in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
You can find the Yocto Project version of the You can find the Yocto Project version of the
<filename>local.conf.sample</filename> file in the <filename>local.conf.sample</filename> file in the
<filename>/meta-yocto/conf</filename> directory. <filename>meta-yocto/conf</filename> directory.
</note> </note>
</para> </para>
</section> </section>
@ -424,9 +425,9 @@
<para> <para>
The source <filename>bblayers.conf.sample</filename> file used The source <filename>bblayers.conf.sample</filename> file used
depends on the <filename>$TEMPLATECONF</filename> script variable, depends on the <filename>$TEMPLATECONF</filename> script variable,
which defaults to <filename>/meta-yocto/conf</filename> which defaults to <filename>meta-yocto/conf</filename>
when you are building from the Yocto Project development when you are building from the Yocto Project development
environment and defaults to <filename>/meta/conf</filename> when environment and defaults to <filename>meta/conf</filename> when
you are building from the OpenEmbedded Core environment. you are building from the OpenEmbedded Core environment.
Because the script variable points to the source of the Because the script variable points to the source of the
<filename>bblayers.conf.sample</filename> file, this implies that <filename>bblayers.conf.sample</filename> file, this implies that
@ -441,11 +442,11 @@
values for all <filename>##OEROOT##</filename> values. values for all <filename>##OEROOT##</filename> values.
<note> <note>
You can see how the <filename>TEMPLATECONF</filename> variable You can see how the <filename>TEMPLATECONF</filename> variable
<filename>/scripts/oe-setup-builddir</filename> script in the <filename>scripts/oe-setup-builddir</filename> script in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
You can find the Yocto Project version of the You can find the Yocto Project version of the
<filename>bblayers.conf.sample</filename> file in the <filename>bblayers.conf.sample</filename> file in the
<filename>/meta-yocto/conf</filename> directory. <filename>meta-yocto/conf</filename> directory.
</note> </note>
</para> </para>
</section> </section>
@ -487,7 +488,7 @@
<title><filename>build/tmp/</filename></title> <title><filename>build/tmp/</filename></title>
<para> <para>
This directory receives all the OpenEmbedded build system's output. This directory receives all of the OpenEmbedded build system's output.
BitBake creates this directory if it does not exist. BitBake creates this directory if it does not exist.
As a last resort, to clean up a build and start it from scratch (other than the downloads), As a last resort, to clean up a build and start it from scratch (other than the downloads),
you can remove everything in the <filename>tmp</filename> directory or get rid of the you can remove everything in the <filename>tmp</filename> directory or get rid of the
@ -551,6 +552,15 @@
</para> </para>
</section> </section>
<section id='structure-build-tmp-deploy-ipk'>
<title><filename>build/tmp/deploy/ipk/</filename></title>
<para>
This directory receives <filename>.ipk</filename> packages produced by
the build process.
</para>
</section>
<section id='structure-build-tmp-deploy-licenses'> <section id='structure-build-tmp-deploy-licenses'>
<title><filename>build/tmp/deploy/licenses/</filename></title> <title><filename>build/tmp/deploy/licenses/</filename></title>
@ -597,14 +607,6 @@
</para> </para>
</section> </section>
<section id='structure-build-tmp-deploy-ipk'>
<title><filename>build/tmp/deploy/ipk/</filename></title>
<para>
This directory receives <filename>.ipk</filename> packages produced by
the build process.</para>
</section>
<section id='structure-build-tmp-sysroots'> <section id='structure-build-tmp-sysroots'>
<title><filename>build/tmp/sysroots/</filename></title> <title><filename>build/tmp/sysroots/</filename></title>
@ -646,15 +648,6 @@
</para> </para>
</section> </section>
<section id='structure-build-tmp-pkgdata'>
<title><filename>build/tmp/pkgdata/</filename></title>
<para>
This directory contains intermediate packaging data that is used later in the packaging process.
For more information, see the "<link linkend='ref-classes-package'>Packaging - package*.bbclass</link>" section.
</para>
</section>
<section id='structure-build-tmp-work'> <section id='structure-build-tmp-work'>
<title><filename>build/tmp/work/</filename></title> <title><filename>build/tmp/work/</filename></title>