diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index 2fd2bf0239..82f123be71 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml @@ -708,9 +708,25 @@ your source code modifications. - Build the Recipe: - Once you have updated the source files, you can build - the recipe. + Build the Recipe or Rebuild the Image: + The next step you take depends on what you are going + to do with the new code. + + If you need to eventually move the build output + to the target hardware, use the following + devtool command: + + $ devtool build recipe + + + On the other hand, if you want an image to + contain the recipe's packages from the workspace + for immediate deployment onto a device (e.g. for + testing purposes), you can use + the devtool build-image command: + + $ devtool build-image image + Deploy the Build Output: @@ -800,7 +816,7 @@ workflow to make sure your recipes you are using for builds are up-to-date with their upstream counterparts. - Several methods exist by which you can upgrade recipes. + Several methods exist by which you can upgrade recipes - devtool upgrade happens to be one. You can read about all the methods by which you can upgrade recipes in the @@ -819,12 +835,8 @@ - Depending on your particular scenario, the arguments and - options you use with devtool upgrade form - different combinations. - The following diagram shows a common development flow - you would use with the devtool upgrade - command: + The following diagram shows the common development flow + used with the devtool upgrade command: @@ -835,19 +847,18 @@ Initiate the Upgrade: - The top part of the flow shows a typical scenario by - which you could use - devtool upgrade. + The top part of the flow shows the typical scenario by + which you use the devtool upgrade + command. The following conditions exist: - The recipe exists in some layer external + The recipe exists in a local layer external to the devtool workspace. The source files for the new release - exist adjacent to the same location pointed to - by + exist in the same location pointed to by SRC_URI in the recipe (e.g. a tarball with the new version number in the name, or as a different @@ -888,19 +899,19 @@ Once devtool locates the recipe, it uses the SRC_URI variable to locate the source code and any local patch - files from other developers are located. + files from other developers. The result is that the command sets up the source code, the new version of the recipe, and an append file all within the workspace. - - Resolve any Conflicts created by the Upgrade: - At this point, conflicts could exist due to the - software being upgraded to a new version. + + Resolve any Conflicts created by the Upgrade: + Conflicts could exist due to the software being + upgraded to a new version. Conflicts occur if your recipe specifies some patch files in SRC_URI that conflict with changes made in the new version of the software. - If this is the case, you need to resolve the conflicts + For such cases, you need to resolve the conflicts by editing the source and following the normal git rebase conflict resolution process. @@ -910,13 +921,25 @@ newer or different version of the software. - Build the Recipe: - Once you have your recipe in order, you can build it. - You can either use devtool build - or bitbake. - Either method produces build output that is stored - in - TMPDIR. + Build the Recipe or Rebuild the Image: + The next step you take depends on what you are going + to do with the new code. + + If you need to eventually move the build output + to the target hardware, use the following + devtool command: + + $ devtool build recipe + + + On the other hand, if you want an image to + contain the recipe's packages from the workspace + for immediate deployment onto a device (e.g. for + testing purposes), you can use + the devtool build-image command: + + $ devtool build-image image + Deploy the Build Output: