From 3b374b09df1a35ced459361d31d679d7a0cc8a98 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 16 Jul 2018 14:28:52 -0700 Subject: sdk-manual: Updates to sections for updating installed Ext SDKs There are two sections that deal with this topic. One is from the standpoint of a user using a 3rd party published and installed extensible SDK ("Applying Updates to an Installed Extensible SDK"). The other is from the standpoint of a person providing Extensible SDKs for consumption ("Providing Updates to the Extensible SDK After Installation"). These sections needed some closer examination regarding fully describing what was going on. I provided some re-writes to both. (From yocto-docs rev: 1c60b13b5f1813d6e3688e1efce32b7f31422e86) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../sdk-manual/sdk-appendix-customizing.xml | 21 +++++++++------- documentation/sdk-manual/sdk-extensible.xml | 28 ++++++++++++---------- 2 files changed, 29 insertions(+), 20 deletions(-) (limited to 'documentation/sdk-manual') diff --git a/documentation/sdk-manual/sdk-appendix-customizing.xml b/documentation/sdk-manual/sdk-appendix-customizing.xml index 75d9ecda43..718b9d4c19 100644 --- a/documentation/sdk-manual/sdk-appendix-customizing.xml +++ b/documentation/sdk-manual/sdk-appendix-customizing.xml @@ -213,12 +213,14 @@ When you make changes to your configuration or to the metadata and if you want those changes to be reflected in installed SDKs, you need - to perform additional steps to make it possible for those that use - the SDK to update their installations with the + to perform additional steps. + These steps make it possible for anyone using the installed SDKs to + update the installed SDKs by using the devtool sdk-update command: Create a directory that can be shared over HTTP or HTTPS. + This directory will contain the published SDK. Set the @@ -226,7 +228,10 @@ variable to point to the corresponding HTTP or HTTPS URL. Setting this variable causes any SDK built to default to that URL and thus, the user does not have to pass the URL to the - devtool sdk-update command. + devtool sdk-update command as described + in the + "Applying Updates to an Installed Extensible SDK" + section. Build the extensible SDK normally (i.e., use the @@ -236,7 +241,7 @@ Publish the SDK using the following command: - $ oe-publish-sdk some_path/sdk-installer.sh path_to_shared/http_directory + $ oe-publish-sdk some_path/sdk-installer.sh path_to_shared_http_directory You must repeat this step each time you rebuild the SDK with changes that you want to make available through the @@ -246,11 +251,11 @@ - Completing the above steps allows users of the existing SDKs to - simply run devtool sdk-update to retrieve the - latest updates. + Completing the above steps allows users of the existing installed + SDKs to simply run devtool sdk-update to + retrieve and apply the latest updates. See the - "Updating the Extensible SDK" + "Applying Updates to an Installed Extensible SDK" section for further information. diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index 5215a9d096..09f06088d2 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml @@ -1715,31 +1715,35 @@ -
- Updating the Extensible SDK +
+ Applying Updates to an Installed 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. + If you are working with an installed extensible SDK that gets + occasionally updated (e.g. a third-party SDK), then you will need + to manually "pull down" the updates into the installed SDK. - To update your installed SDK, run the following: + To update your installed SDK, use devtool as + follows: $ 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: + update URL for you through the + SDK_UPDATE_URL + variable as described in the + "Providing Updates to the Extensible SDK After Installation" + section. + If the SDK provider has not set that default URL, you need to + specify it yourself in the command 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. + The URL needs to point specifically to a published SDK and + not to an SDK installer that you would download and install.
-- cgit v1.2.3-54-g00ecf