sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

ref-manual, mega-manual, Makefile: Updates to expanded dev section 

Fixes [YOCTO #2808]

Applied review comments to the "Images" and SDK sections that
are part of the "A Closer Look at the Yocto Project Development
Environment" section.  Comments from Paul.  They resulted
in a single figure being removed and split into two new
figures - one for the image part and one for the sdk part.

Some terminology issues were cleaned up in the main sections
as well as the documented variables sections.

Makefile changes involved adding the two new figures and
removing the old combined one.

(From yocto-docs rev: a32908fa68b9786e295097c16f70a5a9c3cc4c1e)

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-08-05 13:45:59 +03:00 committed by Richard Purdie
parent 4b23d26063
commit 93c76f4c65
10 changed files with 172 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
documentation/Makefile
View File

@ -198,7 +198,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures
figures/sched-wakeup-profile.png figures/sysprof-callers.png \ figures/sched-wakeup-profile.png figures/sysprof-callers.png \
figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png figures/cross-development-toolchains.png \ figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png figures/cross-development-toolchains.png \
figures/yocto-environment-ref.png figures/user-configuration.png figures/source-input.png \ figures/yocto-environment-ref.png figures/user-configuration.png figures/source-input.png \
figures/package-feeds.png figures/layer-input.png figures/images-sdk.png figures/package-feeds.png figures/layer-input.png figures/images.png figures/sdk.png
endif endif
MANUALS = $(DOC)/$(DOC).html MANUALS = $(DOC)/$(DOC).html
@ -215,7 +215,7 @@ TARFILES = ref-manual.html ref-style.css figures/poky-title.png \
figures/cross-development-toolchains.png figures/layer-input.png \ figures/cross-development-toolchains.png figures/layer-input.png \
figures/package-feeds.png figures/source-input.png \ figures/package-feeds.png figures/source-input.png \
figures/user-configuration.png figures/yocto-environment-ref.png \ figures/user-configuration.png figures/yocto-environment-ref.png \
figures/images-sdk.png figures/images.png figures/sdk.png
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
FIGURES = figures FIGURES = figures
STYLESHEET = $(DOC)/*.css STYLESHEET = $(DOC)/*.css

BIN
documentation/mega-manual/figures/images-sdk.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 24 KiB

BIN
documentation/mega-manual/figures/images.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

BIN
documentation/mega-manual/figures/sdk.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

BIN
documentation/ref-manual/figures/images-sdk.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 24 KiB

BIN
documentation/ref-manual/figures/images.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

BIN
documentation/ref-manual/figures/sdk.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

5
documentation/ref-manual/ref-structure.xml
View File

@ -362,8 +362,9 @@
variable points to this directory. variable points to this directory.
For more detail on the contents of the <filename>deploy</filename> For more detail on the contents of the <filename>deploy</filename>
directory, see the directory, see the
"<link linkend='images-and-application-development-sdk'>Images and Application Development SDK</link>" "<link linkend='images-dev-environment'>Images</link>" and
section. "<link linkend='sdk-dev-environment'>Application Development SDK</link>"
sections.
</para> </para>
</section> </section>

29
documentation/ref-manual/ref-variables.xml
View File

@ -780,8 +780,7 @@ Core layer for images cannot be removed
<glossdef> <glossdef>
<para> <para>
Points to the area that the OpenEmbedded build system uses Points to the area that the OpenEmbedded build system uses
to place images and their related files created with to place images and their related files.
BitBake.
By default, this directory resides within the By default, this directory resides within the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
as <filename>tmp/deploy</filename>. as <filename>tmp/deploy</filename>.
@ -794,8 +793,9 @@ Core layer for images cannot be removed
section. section.
For more detail on the contents of the For more detail on the contents of the
<filename>deploy</filename> directory, see the <filename>deploy</filename> directory, see the
"<link linkend='images-and-application-development-sdk'>Images and Application Development SDK</link>" "<link linkend='images-dev-environment'>Images</link>" and
section. "<link linkend='sdk-dev-environment'>Application Development SDK</link>"
sections.
</para> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@ -4008,18 +4008,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef> </glossdef>
</glossentry> </glossentry>
<glossentry id='var-TOOLCHAIN_HOSTS_TASKS'><glossterm>TOOLCHAIN_HOSTS_TASKS</glossterm> <glossentry id='var-TOOLCHAIN_HOST_TASK'><glossterm>TOOLCHAIN_HOST_TASK</glossterm>
<glossdef> <glossdef>
<para> <para>
This variable lists packages BitBake uses when it builds This variable lists packages the OpenEmbedded build system
an SDK installer, which is used to extract and set up a uses when building an SDK, which contains a
cross-development environment. cross-development environment.
The packages specified by this variable are part of the The packages specified by this variable are part of the
toolchain set that runs on the toolchain set that runs on the
<link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>. <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>,
When you build an SDK installer using BitBake, a set of and each package should usually have the prefix
default tasks apply. "nativesdk-".
The tasks you specify here are added to those defaults. When building an SDK using
<filename>bitbake -c populate_sdk &lt;imagename&gt;</filename>,
a default list of packages is set in this variable, but
you can add additional packages to the list.
</para> </para>
<para> <para>
@ -4035,11 +4038,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef> </glossdef>
</glossentry> </glossentry>
<glossentry id='var-TOOLCHAIN_TARGET_TASKS'><glossterm>TOOLCHAIN_TARGET_TASKS</glossterm> <glossentry id='var-TOOLCHAIN_TARGET_TASK'><glossterm>TOOLCHAIN_TARGET_TASK</glossterm>
<glossdef> <glossdef>
<para> <para>
This variable lists packages BitBake uses when it creates This variable lists packages BitBake uses when it creates
the target part of an SDK installer (i.e. the part built the target part of an SDK (i.e. the part built
for the target hardware), which includes libraries and for the target hardware), which includes libraries and
headers. headers.
</para> </para>

103
documentation/ref-manual/technical-details.xml
View File

@ -172,7 +172,7 @@
</para> </para>
<para> <para>
The generalized Yocto Project Devevelopment Environment consists of The generalized Yocto Project Development Environment consists of
several functional areas: several functional areas:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>User Configuration:</emphasis> <listitem><para><emphasis>User Configuration:</emphasis>
@ -797,32 +797,28 @@
</para> </para>
</section> </section>
<section id='images-and-application-development-sdk'>
<title>Images and Application Development SDK</title>
<para>
The purpose of using the OpenEmbedded build system is to produce
an image or a Software Development Kit (SDK).
You can see from the main
<link linkend='a-closer-look-at-the-yocto-project-development-environment'>Yocto Project Development Environment</link>
figure that the output (shown in red) are images and SDKs.
This section is going to look more closely at this output:
<imagedata fileref="figures/images-sdk.png" align="center" width="5in" depth="4in" />
</para>
<section id='images-dev-environment'> <section id='images-dev-environment'>
<title>Images</title> <title>Images</title>
<para> <para>
The images produced by BitBake are compressed forms of the The images produced by the OpenEmbedded build system
are compressed forms of the
root filesystems that are ready to boot on a target device. root filesystems that are ready to boot on a target device.
You can see the You can see from the main
"<link linkend='ref-images'>Images</link>" chapter for a list <link linkend='a-closer-look-at-the-yocto-project-development-environment'>Yocto Project Development Environment</link>
of example images that the Yocto Project provides. figure that BitBake output in part consists of images.
This section is going to look more closely at this output:
<imagedata fileref="figures/images.png" align="center" width="5in" depth="4in" />
</para> </para>
<para> <para>
Images are kept in the For a list of example images that the Yocto Project provides,
the
"<link linkend='ref-images'>Images</link>" chapter.
</para>
<para>
Images are written out to the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
inside the <filename>deploy/images</filename> folder as shown inside the <filename>deploy/images</filename> folder as shown
in the figure. in the figure.
@ -832,21 +828,21 @@
<link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link> <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>
variable points to the <filename>deploy</filename> directory. variable points to the <filename>deploy</filename> directory.
<itemizedlist> <itemizedlist>
<listitem><para><filename>&lt;image&gt;</filename>: <listitem><para><filename>&lt;kernel-image&gt;</filename>:
A <filename>*.bin</filename> image file. A kernel binary file.
The <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> The <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link>
variable setting determines the naming scheme for the variable setting determines the naming scheme for the
image file. kernel image file.
Depending on that variable, the file could begin with Depending on that variable, the file could begin with
a variety of naming strings. a variety of naming strings.
The <filename>deploy/images</filename> directory can The <filename>deploy/images</filename> directory can
contain multiple image files.</para></listitem> contain multiple image files.</para></listitem>
<listitem><para><filename>&lt;root-filesystem&gt;</filename>: <listitem><para><filename>&lt;root-filesystem-image&gt;</filename>:
Root filesystems for the target device (e.g. Root filesystems for the target device (e.g.
<filename>*.ext3</filename> or <filename>*.bz2</filename> <filename>*.ext3</filename> or <filename>*.bz2</filename>
files). files).
The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
variable setting determines the root filesystem variable setting determines the root filesystem image
type. type.
The <filename>deploy/images</filename> directory can The <filename>deploy/images</filename> directory can
contain multiple root filesystems.</para></listitem> contain multiple root filesystems.</para></listitem>
@ -861,21 +857,18 @@
contain multiple kernel module tarballs. contain multiple kernel module tarballs.
</para></listitem> </para></listitem>
<listitem><para><filename>&lt;bootloaders&gt;</filename>: <listitem><para><filename>&lt;bootloaders&gt;</filename>:
Bootloaders supporting the image. Bootloaders supporting the image, if applicable to the
target machine.
The <filename>deploy/images</filename> directory can The <filename>deploy/images</filename> directory can
contain multiple bootloaders. contain multiple bootloaders.
</para></listitem> </para></listitem>
<listitem><para><filename>&lt;symlinks&gt;</filename>: <listitem><para><filename>&lt;symlinks&gt;</filename>:
The <filename>images/deploy</filename> folder contains The <filename>images/deploy</filename> folder contains
a symbolic link for each actual file in the folder. a symbolic link that points to the most recently built file
Links exist for all types of files (i.e. images, for each machine.
root filesystems, bootloaders, and kernel module These links might be useful for external scripts that
tarballs). need to obtain the latest version of each file.
The link scheme for images is such that a single link </para></listitem>
exists for the most recently built image.
In addition to that single image link, additional
links exist on a one-for-one basis that map to each
physical image file.</para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>
@ -884,11 +877,20 @@
<title>Application Development SDK</title> <title>Application Development SDK</title>
<para> <para>
An Application Development SDK (referred to as an In the overview figure of the
"SDK installer" in this section) is a self-extracting SDK <link linkend='a-closer-look-at-the-yocto-project-development-environment'>Yocto Project Development Environment</link>
installer file (<filename>*.sh</filename>) that, when run, the output labeled "Application Development SDK" represents an
installs a cross-development toolchain, a set of libraries SDK.
and headers, and an SDK environment setup script. This section is going to take a closer look at this output:
<imagedata fileref="figures/sdk.png" align="center" width="5in" depth="4in" />
</para>
<para>
The specific form of this output is a self-extracting
SDK installer (<filename>*.sh</filename>) that, when run,
installs the SDK image, which consists of a cross-development
toolchain, a set of libraries and headers, and an SDK
environment setup script.
Running this installer essentially sets up your Running this installer essentially sets up your
cross-development environment. cross-development environment.
You can think of the cross-toolchains as the "host" part You can think of the cross-toolchains as the "host" part
@ -904,7 +906,7 @@
The Yocto Project supports several methods by which you can The Yocto Project supports several methods by which you can
set up this cross-development environment. set up this cross-development environment.
These methods include downloading pre-built SDK installers, These methods include downloading pre-built SDK installers,
building and installing your own SKD installer, or running building and installing your own SDK installer, or running
an Application Development Toolkit (ADT) installer to an Application Development Toolkit (ADT) installer to
install not just cross-development toolchains install not just cross-development toolchains
but also additional tools to help in this type of but also additional tools to help in this type of
@ -924,10 +926,10 @@
</note> </note>
<para> <para>
When built using BitBake, the SDK installers are kept in the Once built, the SDK installers are written out to the
<filename>deploy/sdk</filename> folder inside the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
inside the <filename>deploy/sdk</filename> folder as shown as shown in the figure at the beginning of this section.
in the figure at the beginning of this section.
Several variables exist that help configure these files: Several variables exist that help configure these files:
<itemizedlist> <itemizedlist>
<listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
@ -939,18 +941,20 @@
create packages for the target hardware. create packages for the target hardware.
</para></listitem> </para></listitem>
<listitem><para><link linkend='var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></link>: <listitem><para><link linkend='var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></link>:
Lists the features to include in the libraries. Lists the features to include in the "target" part
of the SDK.
</para></listitem> </para></listitem>
<listitem><para><link linkend='var-TOOLCHAIN_HOSTS_TASKS'><filename>TOOLCHAIN_HOSTS_TASKS</filename></link>: <listitem><para><link linkend='var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></link>:
Lists packages that make up the host Lists packages that make up the host
part of the SDK installer (i.e. the part that runs on part of the SDK installer (i.e. the part that runs on
the <filename>SDKMACHINE</filename>). the <filename>SDKMACHINE</filename>).
When you use <filename>bitbake sdk_populate</filename> When you use
to create the SDK installer, a set of default tasks <filename>bitbake -c populate_sdk &lt;imagename&gt;</filename>
to create the SDK installer, a set of default packages
apply. apply.
This variable allows you to add more tasks. This variable allows you to add more packages.
</para></listitem> </para></listitem>
<listitem><para><link linkend='var-TOOLCHAIN_TARGET_TASKS'><filename>TOOLCHAIN_TARGET_TASKS</filename></link>: <listitem><para><link linkend='var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></link>:
Lists packages that make up the target part Lists packages that make up the target part
of the SDK installer (i.e. the part built for the of the SDK installer (i.e. the part built for the
target hardware). target hardware).
@ -958,7 +962,6 @@
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>
</section>
</section> </section>
<section id="cross-development-toolchain-generation"> <section id="cross-development-toolchain-generation">