From aba386b92cb1bd926a69f703587b133363374dee Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 13 Sep 2016 18:05:31 -0700 Subject: sdk-manual: Updated SDK workflow A new command devtool finish has superceded the final commands in the SDK workflow. I updated the two figures (add and modify) to reflect this new flow. I also updated the ordered number list to match reality. (From yocto-docs rev: 0ba31e730cd748d06eab8d46b38764cda5c4e3bd) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../sdk-manual/figures/sdk-devtool-add-flow.png | Bin 179361 -> 177945 bytes .../sdk-manual/figures/sdk-devtool-modify-flow.png | Bin 146467 -> 164192 bytes .../sdk-manual/sdk-appendix-customizing.xml | 13 +- documentation/sdk-manual/sdk-extensible.xml | 156 ++++++++++++--------- 4 files changed, 96 insertions(+), 73 deletions(-) (limited to 'documentation') diff --git a/documentation/sdk-manual/figures/sdk-devtool-add-flow.png b/documentation/sdk-manual/figures/sdk-devtool-add-flow.png index c09e60e355..985ac331f1 100644 Binary files a/documentation/sdk-manual/figures/sdk-devtool-add-flow.png and b/documentation/sdk-manual/figures/sdk-devtool-add-flow.png differ diff --git a/documentation/sdk-manual/figures/sdk-devtool-modify-flow.png b/documentation/sdk-manual/figures/sdk-devtool-modify-flow.png index cd06c01813..fd684ffbe9 100644 Binary files a/documentation/sdk-manual/figures/sdk-devtool-modify-flow.png and b/documentation/sdk-manual/figures/sdk-devtool-modify-flow.png differ diff --git a/documentation/sdk-manual/sdk-appendix-customizing.xml b/documentation/sdk-manual/sdk-appendix-customizing.xml index 0695707af3..e8a8b8cc9b 100644 --- a/documentation/sdk-manual/sdk-appendix-customizing.xml +++ b/documentation/sdk-manual/sdk-appendix-customizing.xml @@ -384,12 +384,15 @@ You can explicitly control whether or not to include the toolchain - when you build and SDK by setting the + when you build an SDK by setting the SDK_INCLUDE_TOOLCHAIN - variable. - When you set this variable to "1", you cause the toolchain to be - included even when SDK_EXT_TYPE is set to - "minimal". + variable to "1". + In particular, it is useful to include the toolchain when you + have set SDK_EXT_TYPE to + "minimal", which by default, excludes the toolchain. + Also, it is helpful if you are building a small SDK for use with + an IDE, such as Eclipse, or some other tool where you do not want + to take extra steps to install a toolchain. diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index 9b788622f9..8f64745d52 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml @@ -343,42 +343,40 @@ However, devtool does not provide a specific command that allows you to do this. - Optionally Update the Recipe With Patch Files: - Once you are satisfied with the recipe, if you have made - any changes to the source tree that you want to have - applied by the recipe, you need to generate patches - from those changes. - You do this before moving the recipe - to its final layer and cleaning up the workspace area - devtool uses. - This optional step is especially relevant if you are - using or adding third-party software. - To convert commits created using Git to patch files, - use the devtool update-recipe command. + + Finish Your Work With the Recipe: + The devtool finish command creates + any patches corresponding to commits in the local + 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. + + $ devtool finish recipe layer + + + Part of the devtool finish + command converts commits created using Git to patch files. Any changes you want to turn into patches must be committed to the Git repository in the source tree. + + + As mentioned, the devtool finish + command moves the final recipe to its permanent layer. + + + As a final process of the + devtool finish command, the state + of the standard layers and the upstream source is + restored so that you can build the recipe from those + areas rather than the workspace. + + You can use the devtool reset + command to put things back should you decide you + do not want to proceed with your work. + If you do use this command, realize that the source + tree is preserved. - - $ devtool update-recipe recipe - - - Move the Recipe to its Permanent Layer: - Before cleaning up the workspace, you need to move the - final recipe to its permanent layer. - You must do this before using the - devtool reset command if you want to - retain the recipe. - - Reset the Recipe: - As a final step, you can restore the state such that - standard layers and the upstream source is used to build - the recipe rather than data in the workspace. - To reset the recipe, use the devtool reset - command: - - $ devtool reset recipe - @@ -569,42 +567,43 @@ However, devtool does not provide a specific command that allows you to do this. - Optionally Create Patch Files for Your Changes: - After you have debugged your changes, you can - use devtool update-recipe to - generate patch files for all the commits you have - made. - - Patch files are generated only for changes - you have committed. - + + Finish Your Work With the Recipe: + The devtool finish command creates + any patches corresponding to commits in the local + Git repository and then resets the recipe so that the + recipe is built normally rather than from the workspace. - $ devtool update-recipe recipe - - By default, the - devtool update-recipe command - creates the patch files in a folder named the same - as the recipe beneath the folder in which the recipe - resides, and updates the recipe's - SRC_URI - statement to point to the generated patch files. + $ devtool finish recipe layer + + + Part of the devtool finish + command converts commits created using Git to patch files. + + Any changes you want to turn into patches must be + committed to the Git repository in the source tree. + + + Because there is no need to move the recipe, + devtool finish either updates the + original recipe in the original layer or the command + creates a .bbappend in a different + layer as provided by layer. + + + As a final process of the + devtool finish command, the state + of the standard layers and the upstream source is + restored so that you can build the recipe from those + areas rather than the workspace. - You can use the - "--append LAYERDIR" - option to cause the command to create append files - in a specific layer rather than the default - recipe layer. + You can use the devtool reset + command to put things back should you decide you + do not want to proceed with your work. + If you do use this command, realize that the source + tree is preserved. - Restore the Workspace: - The devtool reset restores the - state so that standard layers and upstream sources are - used to build the recipe rather than what is in the - workspace. - - $ devtool reset recipe - - @@ -641,8 +640,7 @@ Binary package (i.e. "-b" option) - Node.js module through - npm + Node.js module Python modules that use setuptools @@ -921,8 +919,15 @@ Adding Node.js Modules - You can use the devtool add command in the - following form to add Node.js modules: + You can use the devtool add command two + different ways to add Node.js modules: 1) Through + npm and, 2) from a repository or local + source. + + + + Use the following form to add Node.js modules through + npm: $ devtool add "npm://registry.npmjs.org;name=forever;version=0.15.1" @@ -955,6 +960,21 @@ + + + As mentioned earlier, you can also add Node.js modules + directly from a repository or local source tree. + To add modules this way, use devtool add in + the following form: + + $ devtool add https://github.com/diversario/node-ssdp + + In this example, devtool fetches the specified + Git repository, detects that the code is Node.js code, fetches + dependencies using npm, and sets + SRC_URI + accordingly. + -- cgit v1.2.3-54-g00ecf