ref-manual: Review comments added.

Fixes [YOCTO #2808]

Applied review comments from Paul Eggleton on the user configuration
and the layers section.  Changes applied to the figure for the
user configuration section as well.

(From yocto-docs rev: b05af4b740f0daf3d6c59acf71c362decba2a176)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2013-07-15 08:30:15 +03:00
committed by Richard Purdie
parent c7ac8851c8
commit cb66b6e1a2
2 changed files with 28 additions and 20 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

@@ -184,13 +184,19 @@
<listitem><para><emphasis>Source Files:</emphasis> <listitem><para><emphasis>Source Files:</emphasis>
Upstream releases, local projects, and SCMs.</para></listitem> Upstream releases, local projects, and SCMs.</para></listitem>
<listitem><para><emphasis>Build System:</emphasis> <listitem><para><emphasis>Build System:</emphasis>
Processes inside the BitBake "box". Processes under the control of BitBake.
This block expands on how BitBake fetches source, applies This block expands on how BitBake fetches source, applies
patches, completes compilation, analyzes output for package patches, completes compilation, analyzes output for package
generation, creates and tests packages, generates images, and generation, creates and tests packages, generates images, and
generates cross-development tools.</para></listitem> generates cross-development tools.</para></listitem>
<listitem><para><emphasis>Package Feeds:</emphasis> <listitem><para><emphasis>Package Feeds:</emphasis>
Package feeds into the BitBake process.</para></listitem> Directories containing output packages (rpm, deb or ipk),
which are subsequently used in the construction of an image or
SDK, produced by the build system.
These feeds can also be copied and shared using a web server or
other means to facilitate extending or updating existing
images on devices at runtime if runtime package management is
enabled.</para></listitem>
<listitem><para><emphasis>Images:</emphasis> <listitem><para><emphasis>Images:</emphasis>
Images produced by the development process. Images produced by the development process.
Where do they go? Where do they go?
@@ -269,12 +275,11 @@
<para> <para>
Because the Poky repository is fundamentally an aggregation of Because the Poky repository is fundamentally an aggregation of
existing repositories, some users might be familiar with running existing repositories, some users might be familiar with running
the <filename>oe-init-build-env</filename> script in the context the <filename>oe-init-build-env</filename> script in the context of
of the OpenEmbedded development environment, which is outside separate OpenEmbedded-Core and BitBake repositories rather than a
of the Yocto Project development environment. single Poky repository.
This discussion assumes the script is executed from within a This discussion assumes the script is executed from within a cloned
cloned or unpacked version of Poky (i.e. within the Yocto Project or unpacked version of Poky.
environment).
</para> </para>
<para> <para>
@@ -514,16 +519,16 @@
This area holds configuration files for the This area holds configuration files for the
layer (<filename>conf/layer.conf</filename>), layer (<filename>conf/layer.conf</filename>),
the distribution the distribution
(<filename>conf/distro/&lt;distro&lt;.conf</filename>), (<filename>conf/distro/&lt;distro&gt;.conf</filename>),
and any distribution-wide include files. and any distribution-wide include files.
</para></listitem> </para></listitem>
<listitem><para><emphasis>recipes-*:</emphasis> <listitem><para><emphasis>recipes-*:</emphasis>
Recipes and append files that affect common Recipes and append files that affect common
functionality across the distribution. functionality across the distribution.
This area also can hold common distribution headers, This area could include recipes and append files to
initialization files, and to add distribution-specific configuration,
<filename>&lt;recipe&gt;/files/defconfig</filename> initialization scripts, custom image recipes,
files for the distribution.</para></listitem> and so forth.</para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>
@@ -535,10 +540,13 @@
The BSP Layer provides machine configurations. The BSP Layer provides machine configurations.
Everything in this layer is specific to the machine for which Everything in this layer is specific to the machine for which
you are building the image or the SDK. you are building the image or the SDK.
BSP Layers have a structure that is followed if they are A common structure or form is defined for BSP layers.
considered to be compatible with the Yocto Project. You can learn more about this structure in the
For information on the structure, see the
<ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
<note>
In order for a BSP layer to be considered compliant with the
Yocto Project, it must meet some structural requirements.
</note>
</para> </para>
<para> <para>
@@ -568,8 +576,8 @@
<title>Software Layer</title> <title>Software Layer</title>
<para> <para>
The software layer provides the Metadata for your source The software layer provides the Metadata for your
code used during the build. software packages used during the build.
This layer does not include Metadata that is specific to the This layer does not include Metadata that is specific to the
distribution or the machine, which are found in their distribution or the machine, which are found in their
respective layers. respective layers.
@@ -578,8 +586,8 @@
<para> <para>
This layer contains any new recipes that your project needs This layer contains any new recipes that your project needs
in the form of recipe files. in the form of recipe files.
Patch files are stored in the <filename>files</filename> If the software layer contains any patch files, they can be
directory. stored in a <filename>files</filename> directory.
</para> </para>
</section> </section>
</section> </section>