From 49bcb74203195b5a67e8cb7c5aa26fa29fe3f537 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 29 Jun 2015 10:18:09 -0700 Subject: dev-manual: Applied review edits to devtool section. (From yocto-docs rev: 2b04710ccb1c63c4dafc2abbb79f5a7feddf43e9) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-model.xml | 225 +++++++++++++------------- 1 file changed, 108 insertions(+), 117 deletions(-) (limited to 'documentation/dev-manual/dev-manual-model.xml') diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 9c549d7464..6e0ded2f17 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -1721,44 +1721,17 @@ section. - - The workflow considers the entire build process for the - image and not just modification of the external source - code. - -
- Establish the Reference Image - - - The steps to clone the poky Git - repository, build out an image, and test it using QEMU - are well documented as follows: - - - For information on how to set up a local copy of the - poky repository and on how to - build a Yocto Project image, see the - "Building Images" - section in the Yocto Project Quick Start. - - - For information on how to test an image using QEMU, see - the - "Using the Quick EMUlator (QEMU)" - section. - - - - - - Before you start making modifications to your project's - source code, you should be sure you have the appropriate - local repositories and have a base image built using - BitBake that you can run on QEMU. - -
+ + The steps in this section assume you have a previously built + image that is already either running in QEMU or running on actual + hardware. + Also, it is assumed that for deployment of the image to the + target, SSH is installed in the image and if the image is running + on real hardware that you have network access to and from your + development machine. +
Update Your External Source @@ -1806,18 +1779,12 @@ $ devtool add your-project-name path-to-source - Running devtool add modifies the - bblayers.conf that the - OpenEmbedded build system uses to build an image. - For more information on the bblayers.conf, - see the - "build/conf/bblayers.conf" - section in the Yocto Project Reference Manual. - Running devtool add adds a new workspace - layer to the bblayers.conf file that + Running devtool for the first time + creates a workspace layer through the + bblayers.conf file that is based on your project's location: path-to-source/build-directory/workspace-layer @@ -1918,6 +1885,7 @@
+
@@ -2003,7 +1972,8 @@ name and using --help: $ devtool add --help - usage: devtool add [-h] [--same-dir] [--version VERSION] recipename srctree + usage: devtool add [-h] [--same-dir] [--fetch URI] [--version VERSION] + recipename srctree Adds a new recipe @@ -2013,9 +1983,11 @@ optional arguments: -h, --help show this help message and exit - --same-dir, -s Build in same directory as source (default: False) + --same-dir, -s Build in same directory as source + --fetch URI, -f URI Fetch the specified URI and extract it to create the + source tree --version VERSION, -V VERSION - Version to use within recipe (PV) (default: None) + Version to use within recipe (PV)
@@ -2034,11 +2006,11 @@ The following example creates and adds a new recipe named - jackson-2.0 to the workspace layer. + jackson to the workspace layer. The source code built by the recipes resides in /home/scottrif/sources/jackson: - $ devtool add jackson-2.0 /home/scottrif/sources/jackson + $ devtool add jackson /home/scottrif/sources/jackson For complete syntax, use the @@ -2082,44 +2054,8 @@ -
- Creating the Workspace Layer - - - Use the devtool create-workspace command to - create a new workspace layer in your - Build Directory. - When you create a new workspace layer, it is populated with the - README file and the - conf directory only. - - - - The following example creates a new workspace layer in your - current working and by default names the workspace layer - "workspace": - - $ devtool create-workspace - - - For complete syntax, use the - devtool create-workspace --help command. - - - - - You can create a workspace layer anywhere by supplying - a pathname with the command. - The following command creates a new workspace layer named - "new-workspace": - - $ devtool create-workspace /home/scottrif/new-workspace - - -
-
- Modifying a Recipe + Modifying an Existing Recipe Use the devtool modify command to begin @@ -2144,18 +2080,62 @@ Using the above command form, the default development branch would be "devtool". + + For complete syntax, use the + devtool modify --help command. + +
+ +
+ Updating a Recipe - If you want to name a development branch, use the - -b option with the - -x option: + Use the devtool update-recipe command to + update your recipe with patches that reflect changes you make + to the source files. + For example, if you know you are going to work on some + code, you could first use the + devtool modify + command to extract the code and set up the workspace. + After which, you could modify, compile, and test the code. + + + + When you are satisfied with the results and you have committed + your changes to the Git repository, you can then + run the devtool update-recipe to create the + patches and update the recipe: - $ devtool modify -x -b branch recipe path-to-source + $ devtool update-recipe recipe + If you run the devtool update-recipe + without committing your changes, the command ignores the + changes. + + + + Often, you might want to apply customizations made to your + software in your own layer rather than apply them to the + original recipe. + If so, you can use the + -a or --append + option with the devtool update-recipe + command. + These options allow you to specify the layer into which to + write an append file: + + $ devtool update-recipe recipe -a base-layer-directory + + The *.bbappend file is created at the + appropriate path within the specified layer directory, which + may or may not be in your bblayers.conf + file. + If an append file already exists, the command updates it + appropriately. For complete syntax, use the - devtool modify --help command. + devtool update-recipe --help command.
@@ -2188,31 +2168,6 @@ -
- Updating a Recipe - - - Use the devtool update-recipe command to - update your recipe with patches that reflect changes you make - to the source files. - For example, if you know you are going to work on some - code, you could first use the - devtool modify - command to extract the code and set up the workspace. - After which, you could modify, compile, and test the code. - When you are satisfied with the results you can then - run the devtool update-recipe to create the - patches and update the recipe: - - $ devtool update-recipe recipe - - - For complete syntax, use the - devtool update-recipe --help command. - - -
-
Building Your Software @@ -2295,6 +2250,42 @@
+ +
+ Creating the Workspace Layer in an Alternative Location + + + Use the devtool create-workspace command to + create a new workspace layer in your + Build Directory. + When you create a new workspace layer, it is populated with the + README file and the + conf directory only. + + + + The following example creates a new workspace layer in your + current working and by default names the workspace layer + "workspace": + + $ devtool create-workspace + + + For complete syntax, use the + devtool create-workspace --help command. + + + + + You can create a workspace layer anywhere by supplying + a pathname with the command. + The following command creates a new workspace layer named + "new-workspace": + + $ devtool create-workspace /home/scottrif/new-workspace + + +
-- cgit v1.2.3-54-g00ecf