diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2016-09-21 11:44:43 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-09-28 15:02:32 +0100 |
commit | 959a0620961d5404f826d3545109bb08057fe391 (patch) | |
tree | 6baf56b4e7b2b29ff6a746e2ec058d7af4a24eab | |
parent | 4404fc3fe05ad5dd899c1952c1f90f0bb3630f40 (diff) | |
download | poky-959a0620961d5404f826d3545109bb08057fe391.tar.gz |
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>
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 22 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-appendix-obtain.xml | 14 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-extensible.xml | 55 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-intro.xml | 2 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-using.xml | 8 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-working-projects.xml | 6 |
6 files changed, 58 insertions, 49 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 1edead3d6b..0b76ad7191 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
@@ -646,12 +646,10 @@ | |||
646 | 646 | ||
647 | <para> | 647 | <para> |
648 | The remainder of this section presents these workflows. | 648 | The remainder of this section presents these workflows. |
649 | <note> | 649 | See the |
650 | See the | 650 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-devtool-reference'><filename>devtool</filename> Quick Reference</ulink>" |
651 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-devtool-reference'><filename>devtool</filename> Quick Reference</ulink>" | 651 | in the Yocto Project Reference Manual for a |
652 | in the Yocto Project Reference Manual for more a | 652 | <filename>devtool</filename> quick reference. |
653 | <filename>devtool</filename> reference. | ||
654 | </note> | ||
655 | </para> | 653 | </para> |
656 | 654 | ||
657 | <section id='use-devtool-to-integrate-new-code'> | 655 | <section id='use-devtool-to-integrate-new-code'> |
@@ -1227,11 +1225,13 @@ | |||
1227 | <emphasis>Finish Your Work With the Recipe</emphasis>: | 1225 | <emphasis>Finish Your Work With the Recipe</emphasis>: |
1228 | The <filename>devtool finish</filename> command creates | 1226 | The <filename>devtool finish</filename> command creates |
1229 | any patches corresponding to commits in the local | 1227 | any patches corresponding to commits in the local |
1230 | Git repository, updates the recipe to point to them | 1228 | Git repository, moves the new recipe to a more permanent |
1231 | (or creates a <filename>.bbappend</filename> file to do | 1229 | layer, and then resets the recipe so that the recipe is |
1232 | so, depending on the specified destination layer), and | 1230 | built normally rather than from the workspace. |
1233 | then resets the recipe so that the recipe is built normally | 1231 | If you specify a destination layer that is the same as |
1234 | rather than from the workspace. | 1232 | the original source, then the old version of the |
1233 | recipe and associated files will be removed prior to | ||
1234 | adding the new version. | ||
1235 | <literallayout class='monospaced'> | 1235 | <literallayout class='monospaced'> |
1236 | $ devtool finish <replaceable>recipe layer</replaceable> | 1236 | $ devtool finish <replaceable>recipe layer</replaceable> |
1237 | </literallayout> | 1237 | </literallayout> |
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml index d7df36f827..3156f77258 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.xml +++ b/documentation/sdk-manual/sdk-appendix-obtain.xml | |||
@@ -13,7 +13,7 @@ | |||
13 | You can use existing, pre-built toolchains by locating and running | 13 | You can use existing, pre-built toolchains by locating and running |
14 | an SDK installer script that ships with the Yocto Project. | 14 | an SDK installer script that ships with the Yocto Project. |
15 | Using this method, you select and download an architecture-specific | 15 | Using this method, you select and download an architecture-specific |
16 | toolchain installer and then run the script to hand-install the | 16 | SDK installer and then run the script to hand-install the |
17 | toolchain. | 17 | toolchain. |
18 | </para> | 18 | </para> |
19 | 19 | ||
@@ -26,7 +26,7 @@ | |||
26 | (i.e. <filename>i686</filename> for 32-bit machines or | 26 | (i.e. <filename>i686</filename> for 32-bit machines or |
27 | <filename>x86_64</filename> for 64-bit machines).</para> | 27 | <filename>x86_64</filename> for 64-bit machines).</para> |
28 | 28 | ||
29 | <para>Go into that folder and download the toolchain installer | 29 | <para>Go into that folder and download the SDK installer |
30 | whose name includes the appropriate target architecture. | 30 | whose name includes the appropriate target architecture. |
31 | The toolchains provided by the Yocto Project are based off of | 31 | The toolchains provided by the Yocto Project are based off of |
32 | the <filename>core-image-sato</filename> image and contain | 32 | the <filename>core-image-sato</filename> image and contain |
@@ -56,8 +56,8 @@ | |||
56 | <title>Building an SDK Installer</title> | 56 | <title>Building an SDK Installer</title> |
57 | 57 | ||
58 | <para> | 58 | <para> |
59 | As an alternative to locating and downloading a toolchain installer, | 59 | As an alternative to locating and downloading a SDK installer, |
60 | you can build the toolchain installer assuming you have first sourced | 60 | you can build the SDK installer assuming you have first sourced |
61 | the environment setup script. | 61 | the environment setup script. |
62 | See the | 62 | See the |
63 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" | 63 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" |
@@ -74,7 +74,7 @@ | |||
74 | </para> | 74 | </para> |
75 | 75 | ||
76 | <para> | 76 | <para> |
77 | To build the toolchain installer for a standard SDK and populate | 77 | To build the SDK installer for a standard SDK and populate |
78 | the SDK image, use the following command: | 78 | the SDK image, use the following command: |
79 | <literallayout class='monospaced'> | 79 | <literallayout class='monospaced'> |
80 | $ bitbake <replaceable>image</replaceable> -c populate_sdk | 80 | $ bitbake <replaceable>image</replaceable> -c populate_sdk |
@@ -83,12 +83,12 @@ | |||
83 | <literallayout class='monospaced'> | 83 | <literallayout class='monospaced'> |
84 | $ bitbake <replaceable>image</replaceable> -c populate_sdk_ext | 84 | $ bitbake <replaceable>image</replaceable> -c populate_sdk_ext |
85 | </literallayout> | 85 | </literallayout> |
86 | These commands result in a toolchain installer that contains the sysroot | 86 | These commands result in a SDK installer that contains the sysroot |
87 | that matches your target root filesystem. | 87 | that matches your target root filesystem. |
88 | </para> | 88 | </para> |
89 | 89 | ||
90 | <para> | 90 | <para> |
91 | When the <filename>bitbake</filename> command completes, the toolchain | 91 | When the <filename>bitbake</filename> command completes, the SDK |
92 | installer will be in | 92 | installer will be in |
93 | <filename>tmp/deploy/sdk</filename> in the Build Directory. | 93 | <filename>tmp/deploy/sdk</filename> in the Build Directory. |
94 | <note><title>Notes</title> | 94 | <note><title>Notes</title> |
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index 8c568a739e..e5231233e8 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml | |||
@@ -25,10 +25,12 @@ | |||
25 | </para> | 25 | </para> |
26 | 26 | ||
27 | <para> | 27 | <para> |
28 | You can use an extensible SDK to work on Makefile, Autotools, and | 28 | In addition to the functionality available through |
29 | <filename>devtool</filename>, you can alternatively make use of | ||
30 | the toolchain directly to work on Makefile, Autotools, and | ||
29 | Eclipse-based projects. | 31 | Eclipse-based projects. |
30 | See the | 32 | See the |
31 | "<link linkend='sdk-working-projects'>Working with Different Types of Projects</link>" | 33 | "<link linkend='sdk-working-projects'>Using the SDK Toolchain Directly</link>" |
32 | chapter for more information. | 34 | chapter for more information. |
33 | </para> | 35 | </para> |
34 | 36 | ||
@@ -102,7 +104,7 @@ | |||
102 | 104 | ||
103 | &DISTRO;, &DISTRO;+snapshot | 105 | &DISTRO;, &DISTRO;+snapshot |
104 | </literallayout> | 106 | </literallayout> |
105 | For example, the following toolchain installer is for a 64-bit | 107 | For example, the following SDK installer is for a 64-bit |
106 | development host system and a i586-tuned target architecture | 108 | development host system and a i586-tuned target architecture |
107 | based off the SDK for <filename>core-image-sato</filename> and | 109 | based off the SDK for <filename>core-image-sato</filename> and |
108 | using the current &DISTRO; snapshot: | 110 | using the current &DISTRO; snapshot: |
@@ -111,7 +113,7 @@ | |||
111 | </literallayout> | 113 | </literallayout> |
112 | <note> | 114 | <note> |
113 | As an alternative to downloading an SDK, you can build the | 115 | As an alternative to downloading an SDK, you can build the |
114 | toolchain installer. | 116 | SDK installer. |
115 | For information on building the installer, see the | 117 | For information on building the installer, see the |
116 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" | 118 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" |
117 | section. | 119 | section. |
@@ -138,7 +140,7 @@ | |||
138 | The following command shows how to run the installer given a | 140 | The following command shows how to run the installer given a |
139 | toolchain tarball for a 64-bit x86 development host system and | 141 | toolchain tarball for a 64-bit x86 development host system and |
140 | a 64-bit x86 target architecture. | 142 | a 64-bit x86 target architecture. |
141 | The example assumes the toolchain installer is located in | 143 | The example assumes the SDK installer is located in |
142 | <filename>~/Downloads/</filename>. | 144 | <filename>~/Downloads/</filename>. |
143 | <note> | 145 | <note> |
144 | If you do not have write permissions for the directory | 146 | If you do not have write permissions for the directory |
@@ -231,36 +233,41 @@ | |||
231 | called <filename>devtool</filename>. | 233 | called <filename>devtool</filename>. |
232 | This tool provides a number of features that help | 234 | This tool provides a number of features that help |
233 | you build, test and package software within the extensible SDK, and | 235 | you build, test and package software within the extensible SDK, and |
234 | optionally integrate it into an image built by the OpenEmbedded build | 236 | optionally integrate it into an image built by the OpenEmbedded |
235 | system. | 237 | build system. |
236 | </para> | 238 | </para> |
237 | 239 | ||
238 | <para> | 240 | <para> |
239 | The <filename>devtool</filename> command line is organized similarly | 241 | The <filename>devtool</filename> command line is organized |
240 | to | 242 | similarly to |
241 | <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> in that it has a | 243 | <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> in that it has a |
242 | number of sub-commands for each function. | 244 | number of sub-commands for each function. |
243 | You can run <filename>devtool --help</filename> to see all the | 245 | You can run <filename>devtool --help</filename> to see all the |
244 | commands. | 246 | commands. |
245 | <note> | 247 | See the |
246 | See the | 248 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-devtool-reference'><filename>devtool</filename> Quick Reference</ulink>" |
247 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-devtool-reference'><filename>devtool</filename> Quick Reference</ulink>" | 249 | in the Yocto Project Reference Manual for a |
248 | in the Yocto Project Reference Manual for more a | 250 | <filename>devtool</filename> quick reference. |
249 | <filename>devtool</filename> reference. | ||
250 | </note> | ||
251 | </para> | 251 | </para> |
252 | 252 | ||
253 | <para> | 253 | <para> |
254 | Two <filename>devtool</filename> subcommands that provide | 254 | Three <filename>devtool</filename> subcommands that provide |
255 | entry-points into development are: | 255 | entry-points into development are: |
256 | <itemizedlist> | 256 | <itemizedlist> |
257 | <listitem><para><emphasis><filename>devtool add</filename></emphasis>: | 257 | <listitem><para> |
258 | <emphasis><filename>devtool add</filename></emphasis>: | ||
258 | Assists in adding new software to be built. | 259 | Assists in adding new software to be built. |
259 | </para></listitem> | 260 | </para></listitem> |
260 | <listitem><para><emphasis><filename>devtool modify</filename></emphasis>: | 261 | <listitem><para> |
262 | <emphasis><filename>devtool modify</filename></emphasis>: | ||
261 | Sets up an environment to enable you to modify the source of | 263 | Sets up an environment to enable you to modify the source of |
262 | an existing component. | 264 | an existing component. |
263 | </para></listitem> | 265 | </para></listitem> |
266 | <listitem><para> | ||
267 | <emphasis><filename>devtool upgrade</filename></emphasis>: | ||
268 | Updates an existing recipe so that you can build it for | ||
269 | an updated set of source files. | ||
270 | </para></listitem> | ||
264 | </itemizedlist> | 271 | </itemizedlist> |
265 | As with the OpenEmbedded build system, "recipes" represent software | 272 | As with the OpenEmbedded build system, "recipes" represent software |
266 | packages within <filename>devtool</filename>. | 273 | packages within <filename>devtool</filename>. |
@@ -853,11 +860,13 @@ | |||
853 | <emphasis>Finish Your Work With the Recipe</emphasis>: | 860 | <emphasis>Finish Your Work With the Recipe</emphasis>: |
854 | The <filename>devtool finish</filename> command creates | 861 | The <filename>devtool finish</filename> command creates |
855 | any patches corresponding to commits in the local | 862 | any patches corresponding to commits in the local |
856 | Git repository, updates the recipe to point to them | 863 | Git repository, moves the new recipe to a more permanent |
857 | (or creates a <filename>.bbappend</filename> file to do | 864 | layer, and then resets the recipe so that the recipe is |
858 | so, depending on the specified destination layer), and | 865 | built normally rather than from the workspace. |
859 | then resets the recipe so that the recipe is built normally | 866 | If you specify a destination layer that is the same as |
860 | rather than from the workspace. | 867 | the original source, then the old version of the |
868 | recipe and associated files will be removed prior to | ||
869 | adding the new version. | ||
861 | <literallayout class='monospaced'> | 870 | <literallayout class='monospaced'> |
862 | $ devtool finish <replaceable>recipe layer</replaceable> | 871 | $ devtool finish <replaceable>recipe layer</replaceable> |
863 | </literallayout> | 872 | </literallayout> |
diff --git a/documentation/sdk-manual/sdk-intro.xml b/documentation/sdk-manual/sdk-intro.xml index e0f51e1cf1..68401690de 100644 --- a/documentation/sdk-manual/sdk-intro.xml +++ b/documentation/sdk-manual/sdk-intro.xml | |||
@@ -213,7 +213,7 @@ | |||
213 | hardware. | 213 | hardware. |
214 | Additionally, for an extensible SDK, the toolchain also has | 214 | Additionally, for an extensible SDK, the toolchain also has |
215 | built-in <filename>devtool</filename> functionality. | 215 | built-in <filename>devtool</filename> functionality. |
216 | This toolchain is created by running a toolchain installer script | 216 | This toolchain is created by running a SDK installer script |
217 | or through a | 217 | or through a |
218 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 218 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
219 | that is based on your Metadata configuration or extension for | 219 | that is based on your Metadata configuration or extension for |
diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml index 44cb49c0c8..7281e83ef5 100644 --- a/documentation/sdk-manual/sdk-using.xml +++ b/documentation/sdk-manual/sdk-using.xml | |||
@@ -97,7 +97,7 @@ | |||
97 | 97 | ||
98 | &DISTRO;, &DISTRO;+snapshot | 98 | &DISTRO;, &DISTRO;+snapshot |
99 | </literallayout> | 99 | </literallayout> |
100 | For example, the following toolchain installer is for a 64-bit | 100 | For example, the following SDK installer is for a 64-bit |
101 | development host system and a i586-tuned target architecture | 101 | development host system and a i586-tuned target architecture |
102 | based off the SDK for <filename>core-image-sato</filename> and | 102 | based off the SDK for <filename>core-image-sato</filename> and |
103 | using the current &DISTRO; snapshot: | 103 | using the current &DISTRO; snapshot: |
@@ -106,7 +106,7 @@ | |||
106 | </literallayout> | 106 | </literallayout> |
107 | <note> | 107 | <note> |
108 | As an alternative to downloading an SDK, you can build the | 108 | As an alternative to downloading an SDK, you can build the |
109 | toolchain installer. | 109 | SDK installer. |
110 | For information on building the installer, see the | 110 | For information on building the installer, see the |
111 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" | 111 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" |
112 | section. | 112 | section. |
@@ -124,7 +124,7 @@ | |||
124 | However, when you run the SDK installer, you can choose an | 124 | However, when you run the SDK installer, you can choose an |
125 | installation directory. | 125 | installation directory. |
126 | <note> | 126 | <note> |
127 | You must change the permissions on the toolchain | 127 | You must change the permissions on the SDK |
128 | installer script so that it is executable: | 128 | installer script so that it is executable: |
129 | <literallayout class='monospaced'> | 129 | <literallayout class='monospaced'> |
130 | $ chmod +x poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh | 130 | $ chmod +x poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh |
@@ -136,7 +136,7 @@ | |||
136 | The following command shows how to run the installer given a | 136 | The following command shows how to run the installer given a |
137 | toolchain tarball for a 64-bit x86 development host system and | 137 | toolchain tarball for a 64-bit x86 development host system and |
138 | a 32-bit x86 target architecture. | 138 | a 32-bit x86 target architecture. |
139 | The example assumes the toolchain installer is located in | 139 | The example assumes the SDK installer is located in |
140 | <filename>~/Downloads/</filename>. | 140 | <filename>~/Downloads/</filename>. |
141 | <note> | 141 | <note> |
142 | If you do not have write permissions for the directory | 142 | If you do not have write permissions for the directory |
diff --git a/documentation/sdk-manual/sdk-working-projects.xml b/documentation/sdk-manual/sdk-working-projects.xml index 15e533000c..9bd6868b2b 100644 --- a/documentation/sdk-manual/sdk-working-projects.xml +++ b/documentation/sdk-manual/sdk-working-projects.xml | |||
@@ -4,10 +4,10 @@ | |||
4 | 4 | ||
5 | <chapter id='sdk-working-projects'> | 5 | <chapter id='sdk-working-projects'> |
6 | 6 | ||
7 | <title>Working with Different Types of Projects</title> | 7 | <title>Using the SDK Toolchain Directly</title> |
8 | 8 | ||
9 | <para> | 9 | <para> |
10 | You can use extensible and standard SDKs when working with Makefile, | 10 | You can use the SDK toolchain directly with Makefile, |
11 | Autotools, and <trademark class='trade'>Eclipse</trademark> based | 11 | Autotools, and <trademark class='trade'>Eclipse</trademark> based |
12 | projects. | 12 | projects. |
13 | This chapter covers information specific to each of these types of | 13 | This chapter covers information specific to each of these types of |
@@ -387,7 +387,7 @@ | |||
387 | section for installation information. | 387 | section for installation information. |
388 | <note> | 388 | <note> |
389 | As an alternative to downloading an SDK, you can | 389 | As an alternative to downloading an SDK, you can |
390 | build the toolchain installer. | 390 | build the SDK installer. |
391 | For information on building the installer, see the | 391 | For information on building the installer, see the |
392 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" | 392 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" |
393 | section. | 393 | section. |