diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index dcff37e981..0385fac44c 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -1217,43 +1217,42 @@ 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. + + 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. + + $ devtool finish recipe layer + - Patch files are generated only for changes - you have committed. + 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 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 - - 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. - - Move the Recipe to its Permanent Layer: - Before cleaning up the workspace, you need to move the - final recipe to its permanent layer. - You can either overwrite the original recipe or you can - overlay the upgraded recipe into a separate layer. - You must do this before using the - devtool reset command if you want to - retain the upgraded recipe. - - 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 - diff --git a/documentation/dev-manual/figures/devtool-upgrade-flow.png b/documentation/dev-manual/figures/devtool-upgrade-flow.png index d25168c840..65474dad02 100644 Binary files a/documentation/dev-manual/figures/devtool-upgrade-flow.png and b/documentation/dev-manual/figures/devtool-upgrade-flow.png differ