summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-07-16 14:28:52 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-08-15 10:28:43 +0100
commit3b374b09df1a35ced459361d31d679d7a0cc8a98 (patch)
tree3bfba75ce5614bab84885e7224ce19d73de170b6
parent6cb9fddcab7c6c55bbf703c10688e15654098cfb (diff)
downloadpoky-3b374b09df1a35ced459361d31d679d7a0cc8a98.tar.gz
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 <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/sdk-manual/sdk-appendix-customizing.xml21
-rw-r--r--documentation/sdk-manual/sdk-extensible.xml28
2 files changed, 29 insertions, 20 deletions
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 @@
213 <para> 213 <para>
214 When you make changes to your configuration or to the metadata and 214 When you make changes to your configuration or to the metadata and
215 if you want those changes to be reflected in installed SDKs, you need 215 if you want those changes to be reflected in installed SDKs, you need
216 to perform additional steps to make it possible for those that use 216 to perform additional steps.
217 the SDK to update their installations with the 217 These steps make it possible for anyone using the installed SDKs to
218 update the installed SDKs by using the
218 <filename>devtool sdk-update</filename> command: 219 <filename>devtool sdk-update</filename> command:
219 <orderedlist> 220 <orderedlist>
220 <listitem><para> 221 <listitem><para>
221 Create a directory that can be shared over HTTP or HTTPS. 222 Create a directory that can be shared over HTTP or HTTPS.
223 This directory will contain the published SDK.
222 </para></listitem> 224 </para></listitem>
223 <listitem><para> 225 <listitem><para>
224 Set the 226 Set the
@@ -226,7 +228,10 @@
226 variable to point to the corresponding HTTP or HTTPS URL. 228 variable to point to the corresponding HTTP or HTTPS URL.
227 Setting this variable causes any SDK built to default to that 229 Setting this variable causes any SDK built to default to that
228 URL and thus, the user does not have to pass the URL to the 230 URL and thus, the user does not have to pass the URL to the
229 <filename>devtool sdk-update</filename> command. 231 <filename>devtool sdk-update</filename> command as described
232 in the
233 "<link linkend='sdk-applying-updates-to-an-installed-extensible-sdk'>Applying Updates to an Installed Extensible SDK</link>"
234 section.
230 </para></listitem> 235 </para></listitem>
231 <listitem><para> 236 <listitem><para>
232 Build the extensible SDK normally (i.e., use the 237 Build the extensible SDK normally (i.e., use the
@@ -236,7 +241,7 @@
236 <listitem><para> 241 <listitem><para>
237 Publish the SDK using the following command: 242 Publish the SDK using the following command:
238 <literallayout class='monospaced'> 243 <literallayout class='monospaced'>
239 $ oe-publish-sdk <replaceable>some_path</replaceable>/sdk-installer.sh <replaceable>path_to_shared/http_directory</replaceable> 244 $ oe-publish-sdk <replaceable>some_path</replaceable>/sdk-installer.sh <replaceable>path_to_shared_http_directory</replaceable>
240 </literallayout> 245 </literallayout>
241 You must repeat this step each time you rebuild the SDK 246 You must repeat this step each time you rebuild the SDK
242 with changes that you want to make available through the 247 with changes that you want to make available through the
@@ -246,11 +251,11 @@
246 </para> 251 </para>
247 252
248 <para> 253 <para>
249 Completing the above steps allows users of the existing SDKs to 254 Completing the above steps allows users of the existing installed
250 simply run <filename>devtool sdk-update</filename> to retrieve the 255 SDKs to simply run <filename>devtool sdk-update</filename> to
251 latest updates. 256 retrieve and apply the latest updates.
252 See the 257 See the
253 "<link linkend='sdk-updating-the-extensible-sdk'>Updating the Extensible SDK</link>" 258 "<link linkend='sdk-applying-updates-to-an-installed-extensible-sdk'>Applying Updates to an Installed Extensible SDK</link>"
254 section for further information. 259 section for further information.
255 </para> 260 </para>
256</section> 261</section>
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 @@
1715 </para> 1715 </para>
1716 </section> 1716 </section>
1717 1717
1718 <section id='sdk-updating-the-extensible-sdk'> 1718 <section id='sdk-applying-updates-to-an-installed-extensible-sdk'>
1719 <title>Updating the Extensible SDK</title> 1719 <title>Applying Updates to an Installed Extensible SDK</title>
1720 1720
1721 <para> 1721 <para>
1722 If you are working with an extensible SDK that gets occasionally 1722 If you are working with an installed extensible SDK that gets
1723 updated (e.g. typically when that SDK has been provided to you by 1723 occasionally updated (e.g. a third-party SDK), then you will need
1724 another party), then you will need to manually pull down those 1724 to manually "pull down" the updates into the installed SDK.
1725 updates to your installed SDK.
1726 </para> 1725 </para>
1727 1726
1728 <para> 1727 <para>
1729 To update your installed SDK, run the following: 1728 To update your installed SDK, use <filename>devtool</filename> as
1729 follows:
1730 <literallayout class='monospaced'> 1730 <literallayout class='monospaced'>
1731 $ devtool sdk-update 1731 $ devtool sdk-update
1732 </literallayout> 1732 </literallayout>
1733 The previous command assumes your SDK provider has set the default 1733 The previous command assumes your SDK provider has set the default
1734 update URL for you. 1734 update URL for you through the
1735 If that URL has not been set, you need to specify it yourself as 1735 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_UPDATE_URL'><filename>SDK_UPDATE_URL</filename></ulink>
1736 follows: 1736 variable as described in the
1737 "<link linkend='sdk-providing-updates-to-the-extensible-sdk-after-installation'>Providing Updates to the Extensible SDK After Installation</link>"
1738 section.
1739 If the SDK provider has not set that default URL, you need to
1740 specify it yourself in the command as follows:
1737 <literallayout class='monospaced'> 1741 <literallayout class='monospaced'>
1738 $ devtool sdk-update <replaceable>path_to_update_directory</replaceable> 1742 $ devtool sdk-update <replaceable>path_to_update_directory</replaceable>
1739 </literallayout> 1743 </literallayout>
1740 <note> 1744 <note>
1741 The URL needs to point specifically to a published SDK and not an 1745 The URL needs to point specifically to a published SDK and
1742 SDK installer that you would download and install. 1746 not to an SDK installer that you would download and install.
1743 </note> 1747 </note>
1744 </para> 1748 </para>
1745 </section> 1749 </section>