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

sdk-manual, dev-manual: Applied SDK review edits. 

* Removed the note box formatting for the cross-reference
   from the sdk-manual and dev-manual sections that
   talk about devtool.  The reference is now non-note
   form and goes to the ref-manual devtool quick ref.

 * Added devtool upgrade as a third item in the list that
   introduces methods to use devtool.

 * Fixed the working on the devtool finish step 5 for both
   the dev-manual and sdk-manual.

 * Renamed the new chapter that describes different projects
   you can use devtool on.  The focus is on using the SDK
   toolchain directly.

 * Scrubbed the entire sdk-manual for the term "toolchain
   installer" and replaced with "SDK installer".

(From yocto-docs rev: 6d4daef49cc6d54a700a8c3965c9e8814f75d20a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2016-09-21 11:44:43 -07:00 committed by Richard Purdie
parent 4404fc3fe0
commit 959a062096
6 changed files with 58 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
documentation/dev-manual/dev-manual-model.xml
View File

@ -646,12 +646,10 @@
<para> <para>
The remainder of this section presents these workflows. The remainder of this section presents these workflows.
<note> See the
See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-devtool-reference'><filename>devtool</filename>&nbsp;Quick Reference</ulink>"
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-devtool-reference'><filename>devtool</filename>&nbsp;Quick Reference</ulink>" in the Yocto Project Reference Manual for a
in the Yocto Project Reference Manual for more a <filename>devtool</filename> quick reference.
<filename>devtool</filename> reference.
</note>
</para> </para>
<section id='use-devtool-to-integrate-new-code'> <section id='use-devtool-to-integrate-new-code'>
@ -1227,11 +1225,13 @@
<emphasis>Finish Your Work With the Recipe</emphasis>: <emphasis>Finish Your Work With the Recipe</emphasis>:
The <filename>devtool finish</filename> command creates The <filename>devtool finish</filename> command creates
any patches corresponding to commits in the local any patches corresponding to commits in the local
Git repository, updates the recipe to point to them Git repository, moves the new recipe to a more permanent
(or creates a <filename>.bbappend</filename> file to do layer, and then resets the recipe so that the recipe is
so, depending on the specified destination layer), and built normally rather than from the workspace.
then resets the recipe so that the recipe is built normally If you specify a destination layer that is the same as
rather than from the workspace. the original source, then the old version of the
recipe and associated files will be removed prior to
adding the new version.
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool finish <replaceable>recipe layer</replaceable> $ devtool finish <replaceable>recipe layer</replaceable>
</literallayout> </literallayout>

14
documentation/sdk-manual/sdk-appendix-obtain.xml
View File

@ -13,7 +13,7 @@
You can use existing, pre-built toolchains by locating and running You can use existing, pre-built toolchains by locating and running
an SDK installer script that ships with the Yocto Project. an SDK installer script that ships with the Yocto Project.
Using this method, you select and download an architecture-specific Using this method, you select and download an architecture-specific
toolchain installer and then run the script to hand-install the SDK installer and then run the script to hand-install the
toolchain. toolchain.
</para> </para>
@ -26,7 +26,7 @@
(i.e. <filename>i686</filename> for 32-bit machines or (i.e. <filename>i686</filename> for 32-bit machines or
<filename>x86_64</filename> for 64-bit machines).</para> <filename>x86_64</filename> for 64-bit machines).</para>
<para>Go into that folder and download the toolchain installer <para>Go into that folder and download the SDK installer
whose name includes the appropriate target architecture. whose name includes the appropriate target architecture.
The toolchains provided by the Yocto Project are based off of The toolchains provided by the Yocto Project are based off of
the <filename>core-image-sato</filename> image and contain the <filename>core-image-sato</filename> image and contain
@ -56,8 +56,8 @@
<title>Building an SDK Installer</title> <title>Building an SDK Installer</title>
<para> <para>
As an alternative to locating and downloading a toolchain installer, As an alternative to locating and downloading a SDK installer,
you can build the toolchain installer assuming you have first sourced you can build the SDK installer assuming you have first sourced
the environment setup script. the environment setup script.
See the See the
"<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
@ -74,7 +74,7 @@
</para> </para>
<para> <para>
To build the toolchain installer for a standard SDK and populate To build the SDK installer for a standard SDK and populate
the SDK image, use the following command: the SDK image, use the following command:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ bitbake <replaceable>image</replaceable> -c populate_sdk $ bitbake <replaceable>image</replaceable> -c populate_sdk
@ -83,12 +83,12 @@
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ bitbake <replaceable>image</replaceable> -c populate_sdk_ext $ bitbake <replaceable>image</replaceable> -c populate_sdk_ext
</literallayout> </literallayout>
These commands result in a toolchain installer that contains the sysroot These commands result in a SDK installer that contains the sysroot
that matches your target root filesystem. that matches your target root filesystem.
</para> </para>
<para> <para>
When the <filename>bitbake</filename> command completes, the toolchain When the <filename>bitbake</filename> command completes, the SDK
installer will be in installer will be in
<filename>tmp/deploy/sdk</filename> in the Build Directory. <filename>tmp/deploy/sdk</filename> in the Build Directory.
<note><title>Notes</title> <note><title>Notes</title>

55
documentation/sdk-manual/sdk-extensible.xml
View File

@ -25,10 +25,12 @@
</para> </para>
<para> <para>
You can use an extensible SDK to work on Makefile, Autotools, and In addition to the functionality available through
<filename>devtool</filename>, you can alternatively make use of
the toolchain directly to work on Makefile, Autotools, and
Eclipse-based projects. Eclipse-based projects.
See the See the
"<link linkend='sdk-working-projects'>Working with Different Types of Projects</link>" "<link linkend='sdk-working-projects'>Using the SDK Toolchain Directly</link>"
chapter for more information. chapter for more information.
</para> </para>
@ -102,7 +104,7 @@
&DISTRO;, &DISTRO;+snapshot &DISTRO;, &DISTRO;+snapshot
</literallayout> </literallayout>
For example, the following toolchain installer is for a 64-bit For example, the following SDK installer is for a 64-bit
development host system and a i586-tuned target architecture development host system and a i586-tuned target architecture
based off the SDK for <filename>core-image-sato</filename> and based off the SDK for <filename>core-image-sato</filename> and
using the current &DISTRO; snapshot: using the current &DISTRO; snapshot:
@ -111,7 +113,7 @@
</literallayout> </literallayout>
<note> <note>
As an alternative to downloading an SDK, you can build the As an alternative to downloading an SDK, you can build the
toolchain installer. SDK installer.
For information on building the installer, see the For information on building the installer, see the
"<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>"
section. section.
@ -138,7 +140,7 @@
The following command shows how to run the installer given a The following command shows how to run the installer given a
toolchain tarball for a 64-bit x86 development host system and toolchain tarball for a 64-bit x86 development host system and
a 64-bit x86 target architecture. a 64-bit x86 target architecture.
The example assumes the toolchain installer is located in The example assumes the SDK installer is located in
<filename>~/Downloads/</filename>. <filename>~/Downloads/</filename>.
<note> <note>
If you do not have write permissions for the directory If you do not have write permissions for the directory
@ -231,36 +233,41 @@
called <filename>devtool</filename>. called <filename>devtool</filename>.
This tool provides a number of features that help This tool provides a number of features that help
you build, test and package software within the extensible SDK, and you build, test and package software within the extensible SDK, and
optionally integrate it into an image built by the OpenEmbedded build optionally integrate it into an image built by the OpenEmbedded
system. build system.
</para> </para>
<para> <para>
The <filename>devtool</filename> command line is organized similarly The <filename>devtool</filename> command line is organized
to similarly to
<ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> in that it has a <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> in that it has a
number of sub-commands for each function. number of sub-commands for each function.
You can run <filename>devtool --help</filename> to see all the You can run <filename>devtool --help</filename> to see all the
commands. commands.
<note> See the
See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-devtool-reference'><filename>devtool</filename>&nbsp;Quick Reference</ulink>"
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-devtool-reference'><filename>devtool</filename>&nbsp;Quick Reference</ulink>" in the Yocto Project Reference Manual for a
in the Yocto Project Reference Manual for more a <filename>devtool</filename> quick reference.
<filename>devtool</filename> reference.
</note>
</para> </para>
<para> <para>
Two <filename>devtool</filename> subcommands that provide Three <filename>devtool</filename> subcommands that provide
entry-points into development are: entry-points into development are:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis><filename>devtool add</filename></emphasis>: <listitem><para>
<emphasis><filename>devtool add</filename></emphasis>:
Assists in adding new software to be built. Assists in adding new software to be built.
</para></listitem> </para></listitem>
<listitem><para><emphasis><filename>devtool modify</filename></emphasis>: <listitem><para>
<emphasis><filename>devtool modify</filename></emphasis>:
Sets up an environment to enable you to modify the source of Sets up an environment to enable you to modify the source of
an existing component. an existing component.
</para></listitem> </para></listitem>
<listitem><para>
<emphasis><filename>devtool upgrade</filename></emphasis>:
Updates an existing recipe so that you can build it for
an updated set of source files.
</para></listitem>
</itemizedlist> </itemizedlist>
As with the OpenEmbedded build system, "recipes" represent software As with the OpenEmbedded build system, "recipes" represent software
packages within <filename>devtool</filename>. packages within <filename>devtool</filename>.
@ -853,11 +860,13 @@
<emphasis>Finish Your Work With the Recipe</emphasis>: <emphasis>Finish Your Work With the Recipe</emphasis>:
The <filename>devtool finish</filename> command creates The <filename>devtool finish</filename> command creates
any patches corresponding to commits in the local any patches corresponding to commits in the local
Git repository, updates the recipe to point to them Git repository, moves the new recipe to a more permanent
(or creates a <filename>.bbappend</filename> file to do layer, and then resets the recipe so that the recipe is
so, depending on the specified destination layer), and built normally rather than from the workspace.
then resets the recipe so that the recipe is built normally If you specify a destination layer that is the same as
rather than from the workspace. the original source, then the old version of the
recipe and associated files will be removed prior to
adding the new version.
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool finish <replaceable>recipe layer</replaceable> $ devtool finish <replaceable>recipe layer</replaceable>
</literallayout> </literallayout>

2
documentation/sdk-manual/sdk-intro.xml
View File

@ -213,7 +213,7 @@
hardware. hardware.
Additionally, for an extensible SDK, the toolchain also has Additionally, for an extensible SDK, the toolchain also has
built-in <filename>devtool</filename> functionality. built-in <filename>devtool</filename> functionality.
This toolchain is created by running a toolchain installer script This toolchain is created by running a SDK installer script
or through a or through a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
that is based on your Metadata configuration or extension for that is based on your Metadata configuration or extension for

8
documentation/sdk-manual/sdk-using.xml
View File

@ -97,7 +97,7 @@
&DISTRO;, &DISTRO;+snapshot &DISTRO;, &DISTRO;+snapshot
</literallayout> </literallayout>
For example, the following toolchain installer is for a 64-bit For example, the following SDK installer is for a 64-bit
development host system and a i586-tuned target architecture development host system and a i586-tuned target architecture
based off the SDK for <filename>core-image-sato</filename> and based off the SDK for <filename>core-image-sato</filename> and
using the current &DISTRO; snapshot: using the current &DISTRO; snapshot:
@ -106,7 +106,7 @@
</literallayout> </literallayout>
<note> <note>
As an alternative to downloading an SDK, you can build the As an alternative to downloading an SDK, you can build the
toolchain installer. SDK installer.
For information on building the installer, see the For information on building the installer, see the
"<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>"
section. section.
@ -124,7 +124,7 @@
However, when you run the SDK installer, you can choose an However, when you run the SDK installer, you can choose an
installation directory. installation directory.
<note> <note>
You must change the permissions on the toolchain You must change the permissions on the SDK
installer script so that it is executable: installer script so that it is executable:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ chmod +x poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh $ chmod +x poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
@ -136,7 +136,7 @@
The following command shows how to run the installer given a The following command shows how to run the installer given a
toolchain tarball for a 64-bit x86 development host system and toolchain tarball for a 64-bit x86 development host system and
a 32-bit x86 target architecture. a 32-bit x86 target architecture.
The example assumes the toolchain installer is located in The example assumes the SDK installer is located in
<filename>~/Downloads/</filename>. <filename>~/Downloads/</filename>.
<note> <note>
If you do not have write permissions for the directory If you do not have write permissions for the directory

6
documentation/sdk-manual/sdk-working-projects.xml
View File

@ -4,10 +4,10 @@
<chapter id='sdk-working-projects'> <chapter id='sdk-working-projects'>
<title>Working with Different Types of Projects</title> <title>Using the SDK Toolchain Directly</title>
<para> <para>
You can use extensible and standard SDKs when working with Makefile, You can use the SDK toolchain directly with Makefile,
Autotools, and <trademark class='trade'>Eclipse</trademark> based Autotools, and <trademark class='trade'>Eclipse</trademark> based
projects. projects.
This chapter covers information specific to each of these types of This chapter covers information specific to each of these types of
@ -387,7 +387,7 @@
section for installation information. section for installation information.
<note> <note>
As an alternative to downloading an SDK, you can As an alternative to downloading an SDK, you can
build the toolchain installer. build the SDK installer.
For information on building the installer, see the For information on building the installer, see the
"<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>"
section. section.