From d39e9d1451c316083aee809fee22c539d4b8869d Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 19 Jan 2016 05:26:02 -0800 Subject: ref-manual: Rewrite of "Image Generation" and devtool text. Rewrite of devtool reference section. This was a separate commit but got squashed wrong so it ended up with this commit. The changes to "Image Generation" section reflect the new, more detailed image generation figure (From yocto-docs rev: 827c6872b88c17d2d0c8d44b1024fff19076e505) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-model.xml | 185 +++++++++++++++++++++++++- 1 file changed, 179 insertions(+), 6 deletions(-) (limited to 'documentation/dev-manual') diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index ec11824a56..f82a489fac 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -2113,6 +2113,55 @@ +
+ Extracting the Source for an Existing Recipe + + + Use the devtool extract command to + extract the source for an existing recipe. + When you use this command, you must supply the root name + of the recipe (i.e. no version, paths, or extensions), and + you must supply the directory to which you want the source + extracted. + + + + Additional command options let you control the name of a + development branch into which you can checkout the source + and whether or not to keep a temporary directory, which is + useful for debugging. + + For complete syntax, use the + devtool extract --help command. + + +
+ +
+ Synchronizing a Recipe's Extracted Source Tree + + + Use the devtool sync command to + synchronize a previously extracted source tree for an + existing recipe. + When you use this command, you must supply the root name + of the recipe (i.e. no version, paths, or extensions), and + you must supply the directory to which you want the source + extracted. + + + + Additional command options let you control the name of a + development branch into which you can checkout the source + and whether or not to keep a temporary directory, which is + useful for debugging. + + For complete syntax, use the + devtool sync --help command. + + +
+
Modifying an Existing Recipe @@ -2146,6 +2195,33 @@
+
+ Edit an Existing Recipe + + + Use the devtool edit-recipe command + to run the default editor, which is identified using the + EDITOR variable, on the specified recipe. + + + + When you use the devtool edit-recipe + command, you must supply the root name of the recipe + (i.e. no version, paths, or extensions). + Also, the recipe file itself must reside in the workspace + as a result of the devtool add or + devtool upgrade commands. + However, you can override that requirement by using the + "-a" or "--any-recipe" option. + Using either of these options allows you to edit any recipe + regardless of its location. + + For complete syntax, use the + devtool edit-recipe --help command. + + +
+
Updating a Recipe @@ -2199,6 +2275,36 @@
+
+ Upgrading a Recipe + + + Use the devtool upgrade command + to upgrade an existing recipe to a new upstream version. + The command puts the upgraded recipe file into the + workspace along with any associated files, and extracts + the source tree to a specified location should patches + need rebased or added to as a result of the upgrade. + + + + When you use the devtool upgrade command, + you must supply the root name of the recipe (i.e. no version, + paths, or extensions), and you must supply the directory + to which you want the source extracted. + Additional command options let you control things such as + the version number to which you want to upgrade (i.e. the + PV), + the source revision to which you want to upgrade (i.e. the + SRCREV, + whether or not to apply patches, and so forth. + + For complete syntax, use the + devtool upgrade --help command. + + +
+
Resetting a Recipe @@ -2227,15 +2333,22 @@
-
- Building Your Software +
+ Building Your Recipe Use the devtool build command to cause the - OpenEmbedded build system to build your software based - on the recipe file. + OpenEmbedded build system to build your recipe. The devtool build command is equivalent to bitbake -c populate_sysroot. + + + + When you use the devtool build command, + you must supply the root name of the recipe (i.e. no version, + paths, or extensions). + You can use either the "-s" or the "--disable-parallel-make" + option to disable parallel makes during the build. Here is an example: $ devtool build recipe @@ -2244,8 +2357,25 @@ For complete syntax, use the devtool build --help command. - Building your software using devtool build - is identical to using BitBake to build the software. + +
+ +
+ Building Your Image + + + Use the devtool build-image command + to build an image, extending it to include packages from + recipes in the workspace. + + + + When you use the devtool build-image + command, you must supply the name of the image. + This command has no command line options: + + $ devtool build-image image +
@@ -2345,6 +2475,49 @@
+ +
+ Get the Status of the Recipes in Your Workspace + + + Use the devtool status command to + list the recipes currently in your workspace. + Information includes the paths to their respective + external source trees. + + + + The devtool status command has no + command-line options: + + devtool status + + +
+ +
+ Search for Available Target Recipes + + + Use the devtool search command to + search for available target recipes. + The command matches the recipe name, package name, + description, and installed files. + The command displays the recipe name as a result of a + match. + + + + When you use the devtool search command, + you must supply a keyword. + The command uses the keyword when + searching for a match. + + For complete syntax, use the + devtool search --help command. + + +
-- cgit v1.2.3-54-g00ecf