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 /documentation/sdk-manual/sdk-extensible.xml | |
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>
Diffstat (limited to 'documentation/sdk-manual/sdk-extensible.xml')
-rw-r--r-- | documentation/sdk-manual/sdk-extensible.xml | 55 |
1 files changed, 32 insertions, 23 deletions
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> |