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 @@ The remainder of this section presents these workflows. - - 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.
@@ -1227,11 +1225,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 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 @@ You can use existing, pre-built toolchains by locating and running an SDK installer script that ships with the Yocto Project. 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. @@ -26,7 +26,7 @@ (i.e. i686 for 32-bit machines or x86_64 for 64-bit machines). - Go into that folder and download the toolchain installer + Go into that folder and download the SDK installer whose name includes the appropriate target architecture. The toolchains provided by the Yocto Project are based off of the core-image-sato image and contain @@ -56,8 +56,8 @@ Building an SDK Installer - As an alternative to locating and downloading a toolchain installer, - you can build the toolchain installer assuming you have first sourced + As an alternative to locating and downloading a SDK installer, + you can build the SDK installer assuming you have first sourced the environment setup script. See the "Building Images" @@ -74,7 +74,7 @@ - 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: $ bitbake image -c populate_sdk @@ -83,12 +83,12 @@ $ bitbake image -c populate_sdk_ext - 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. - When the bitbake command completes, the toolchain + When the bitbake command completes, the SDK installer will be in tmp/deploy/sdk in the Build Directory. Notes 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 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 @@ hardware. Additionally, for an extensible SDK, the toolchain also has built-in devtool functionality. - This toolchain is created by running a toolchain installer script + This toolchain is created by running a SDK installer script or through a Build Directory 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 @@ &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: @@ -106,7 +106,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. @@ -124,7 +124,7 @@ However, when you run the SDK installer, you can choose an installation directory. - You must change the permissions on the toolchain + You must change the permissions on the SDK installer script so that it is executable: $ 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 toolchain tarball for a 64-bit x86 development host system and a 32-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 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 @@ - Working with Different Types of Projects + Using the SDK Toolchain Directly - You can use extensible and standard SDKs when working with Makefile, + You can use the SDK toolchain directly with Makefile, Autotools, and Eclipse based projects. This chapter covers information specific to each of these types of @@ -387,7 +387,7 @@ section for installation information. 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 "Building an SDK Installer" section.