From 959a0620961d5404f826d3545109bb08057fe391 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 21 Sep 2016 11:44:43 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/sdk-manual/sdk-extensible.xml | 55 +++++++++++++++++------------ 1 file changed, 32 insertions(+), 23 deletions(-) (limited to 'documentation/sdk-manual/sdk-extensible.xml') 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 @@ - You can use an extensible SDK to work on Makefile, Autotools, and + In addition to the functionality available through + devtool, you can alternatively make use of + the toolchain directly to work on Makefile, Autotools, and Eclipse-based projects. See the - "Working with Different Types of Projects" + "Using the SDK Toolchain Directly" chapter for more information. @@ -102,7 +104,7 @@ &DISTRO;, &DISTRO;+snapshot - 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 based off the SDK for core-image-sato and using the current &DISTRO; snapshot: @@ -111,7 +113,7 @@ As an alternative to downloading an SDK, you can build the - toolchain installer. + SDK installer. For information on building the installer, see the "Building an SDK Installer" section. @@ -138,7 +140,7 @@ The following command shows how to run the installer given a toolchain tarball for a 64-bit x86 development host system and a 64-bit x86 target architecture. - The example assumes the toolchain installer is located in + The example assumes the SDK installer is located in ~/Downloads/. If you do not have write permissions for the directory @@ -231,36 +233,41 @@ called devtool. This tool provides a number of features that help you build, test and package software within the extensible SDK, and - optionally integrate it into an image built by the OpenEmbedded build - system. + optionally integrate it into an image built by the OpenEmbedded + build system. - The devtool command line is organized similarly - to + The devtool command line is organized + similarly to Git in that it has a number of sub-commands for each function. You can run devtool --help to see all the commands. - - See the - "devtool Quick Reference" - in the Yocto Project Reference Manual for more a - devtool reference. - + See the + "devtool Quick Reference" + in the Yocto Project Reference Manual for a + devtool quick reference. - Two devtool subcommands that provide + Three devtool subcommands that provide entry-points into development are: - devtool add: + + devtool add: Assists in adding new software to be built. - devtool modify: + + devtool modify: Sets up an environment to enable you to modify the source of an existing component. + + devtool upgrade: + Updates an existing recipe so that you can build it for + an updated set of source files. + As with the OpenEmbedded build system, "recipes" represent software packages within devtool. @@ -853,11 +860,13 @@ Finish Your Work With the Recipe: The devtool finish command creates any patches corresponding to commits in the local - Git repository, updates the recipe to point to them - (or creates a .bbappend file to do - so, depending on the specified destination layer), and - then resets the recipe so that the recipe is built normally - rather than from the workspace. + Git repository, moves the new recipe to a more permanent + layer, and then resets the recipe so that the recipe is + built normally rather than from the workspace. + If you specify a destination layer that is the same as + the original source, then the old version of the + recipe and associated files will be removed prior to + adding the new version. $ devtool finish recipe layer -- cgit v1.2.3-54-g00ecf