From 7233e359ddc50c80415c746449c33aa0fe83862d Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 21 Mar 2016 14:25:47 -0700 Subject: sdk-manual: Edits to add extensible SDK configuration sections. (From yocto-docs rev: 378bbceb8ea06c225c4758807e25a35521faa3a9) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/sdk-manual/sdk-extensible.xml | 116 +++++++++++++++++++++------- 1 file changed, 90 insertions(+), 26 deletions(-) (limited to 'documentation/sdk-manual/sdk-extensible.xml') diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index bc9ccd28d3..f9f04072d7 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml @@ -540,39 +540,103 @@ -
- Using the Extensible SDK to <replaceable>item-2</replaceable> - - - Describe the specific task you are going to accomplish with the - extensible SDK. - Provide a diagram showing the rough flow of the task. - Provide specific steps using a real example that works through the - task. +
+ Installing Additional Items Into the Extensible SDK + + + The extensible SDK typically only comes with a small number of tools + and libraries out of the box. + If you have a minimal SDK, then it starts mostly empty and is + populated on-demand. + However, sometimes you will need to explicitly install extra items + into the SDK. + If you need these extra items, you can first search for the items + using the devtool search command. + For example, suppose you need to link to libGL but you are not sure + which recipe provides it. + You can use the following command to find out: + + $ devtool search libGL + mesa A free implementation of the OpenGL API + + Once you know the recipe (i.e. mesa in this + example), you can install it: + + $ devtool sdk-install mesa + + By default, the devtool sdk-install assumes the + item is available in pre-built form from your SDK provider. + If the item is not available and it is acceptable to build the item + from source, you can add the "-s" option as follows: + + $ devtool sdk-install -s mesa + + It is important to remember that building the item from source takes + significantly longer than installing the pre-built artifact. + Also, if no recipe exists for the item you want to add to the SDK, you + must add it using the devtool add command.
-
- Using the Extensible SDK to <replaceable>item-3</replaceable> - - - Describe the specific task you are going to accomplish with the - extensible SDK. - Provide a diagram showing the rough flow of the task. - Provide specific steps using a real example that works through the - task. +
+ Updating the Extensible SDK + + + If you are working with an extensible SDK that gets occasionally + updated (e.g. typically when that SDK has been provided to you by + another party), then you will need to manually pull down those + updates to your installed SDK. + + + + To update your installed SDK, run the following: + + $ devtool sdk-update + + The previous command assumes your SDK provider has set the default + update URL for you. + If that URL has not been set, you need to specify it yourself as + follows: + + $ devtool sdk-update path_to_update_directory + + + The URL needs to point specifically to a published SDK and not an + SDK installer that you would download and install. +
-
- Using the Extensible SDK to <replaceable>item-x</replaceable> +
+ Creating a Derivative SDK With Additional Components - - Describe the specific task you are going to accomplish with the - extensible SDK. - Provide a diagram showing the rough flow of the task. - Provide specific steps using a real example that works through the - task. + + You might need to produce an SDK that contains your own custom + libraries for sending to a third party (e.g., if you are a vendor with + customers needing to build their own software for the target platform). + If that is the case, then you can produce a derivative SDK based on + the currently installed SDK fairly easily. + Use these steps: + + If necessary, install an extensible SDK that + you want to use as a base for your derivative SDK. + + Source the environment script for the SDK. + + Add the extra libraries or other components + you want by using the devtool add + command. + + Run the devtool build-sdk + command. + + + The above procedure takes the recipes added to the workspace and + constructs a new SDK installer containing those recipes and the + resulting binary artifacts. + The recipes go into their own separate layer in the constructed + derivative SDK, leaving the workspace clean and ready for you + to add your own recipes.
-- cgit v1.2.3-54-g00ecf