diff options
Diffstat (limited to 'documentation/sdk-manual/appendix-customizing.rst')
| -rw-r--r-- | documentation/sdk-manual/appendix-customizing.rst | 62 |
1 files changed, 31 insertions, 31 deletions
diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst index 9a76cc59d6a..61091d83baf 100644 --- a/documentation/sdk-manual/appendix-customizing.rst +++ b/documentation/sdk-manual/appendix-customizing.rst @@ -1,11 +1,17 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK -****************************** -Customizing the Extensible SDK -****************************** +*************************************************** +Customizing the Extensible SDK standalone installer +*************************************************** This appendix describes customizations you can apply to the extensible -SDK. +SDK when using in the standalone installer version. + +.. note:: + + It is also possible to use the Extensible SDK functionality directly in a + Yocto build, avoiding separate installer artefacts. Please refer to + ":ref:`sdk-manual/extensible:Installing the Extensible SDK`" Configuring the Extensible SDK ============================== @@ -38,14 +44,12 @@ build system applies them against ``local.conf`` and ``auto.conf``: :term:`ESDK_LOCALCONF_ALLOW` overrides either of the previous two filters. The default value is blank. -- Classes inherited globally with - :term:`INHERIT` that are listed in - :term:`ESDK_CLASS_INHERIT_DISABLE` - are disabled. Using :term:`ESDK_CLASS_INHERIT_DISABLE` to disable these - classes is the typical method to disable classes that are problematic - or unnecessary in the SDK context. The default value disables the - :ref:`buildhistory <ref-classes-buildhistory>` - and :ref:`icecc <ref-classes-icecc>` classes. +- Classes inherited globally with :term:`INHERIT` that are listed in + :term:`ESDK_CLASS_INHERIT_DISABLE` are disabled. Using + :term:`ESDK_CLASS_INHERIT_DISABLE` to disable these classes is the typical + method to disable classes that are problematic or unnecessary in the SDK + context. The default value disables the + :ref:`ref-classes-buildhistory` and :ref:`ref-classes-icecc` classes. Additionally, the contents of ``conf/sdk-extra.conf``, when present, are appended to the end of ``conf/local.conf`` within the produced SDK, @@ -68,13 +72,12 @@ adjustments: .. note:: - The default value of - ESDK_CLASS_INHERIT_DISABLE + The default value of :term:`ESDK_CLASS_INHERIT_DISABLE` is set using the "?=" operator. Consequently, you will need to either define the entire list by using the "=" operator, or you will need to append a value using either ":append" or the "+=" operator. You can learn more about these operators in the - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" + ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" section of the BitBake User Manual. - If you have classes or recipes that add additional tasks to the @@ -169,13 +172,12 @@ 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: -1. Create a directory that can be shared over HTTP or HTTPS. You can do - this by setting up a web server such as an `Apache HTTP - Server <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__ or - `Nginx <https://en.wikipedia.org/wiki/Nginx>`__ server in the cloud +#. Create a directory that can be shared over HTTP or HTTPS. You can do + this by setting up a web server such as an :wikipedia:`Apache HTTP Server + <Apache_HTTP_Server>` or :wikipedia:`Nginx <Nginx>` server in the cloud to host the directory. This directory must contain the published SDK. -2. Set the +#. Set the :term:`SDK_UPDATE_URL` variable to point to the corresponding HTTP or HTTPS URL. Setting this variable causes any SDK built to default to that URL and thus, @@ -184,10 +186,10 @@ the installed SDKs to update the installed SDKs by using the ":ref:`sdk-manual/extensible:applying updates to an installed extensible sdk`" section. -3. Build the extensible SDK normally (i.e., use the +#. Build the extensible SDK normally (i.e., use the ``bitbake -c populate_sdk_ext`` imagename command). -4. Publish the SDK using the following command:: +#. Publish the SDK using the following command:: $ oe-publish-sdk some_path/sdk-installer.sh path_to_shared_http_directory @@ -242,7 +244,7 @@ If you want the users of an extensible SDK you build to be able to add items to the SDK without requiring the users to build the items from source, you need to do a number of things: -1. Ensure the additional items you want the user to be able to install +#. Ensure the additional items you want the user to be able to install are already built: - Build the items explicitly. You could use one or more "meta" @@ -254,13 +256,12 @@ source, you need to do a number of things: :term:`EXCLUDE_FROM_WORLD` variable for additional information. -2. Expose the ``sstate-cache`` directory produced by the build. +#. Expose the ``sstate-cache`` directory produced by the build. Typically, you expose this directory by making it available through - an `Apache HTTP - Server <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__ or - `Nginx <https://en.wikipedia.org/wiki/Nginx>`__ server. + an :wikipedia:`Apache HTTP Server <Apache_HTTP_Server>` or + :wikipedia:`Nginx <Nginx>` server. -3. Set the appropriate configuration so that the produced SDK knows how +#. Set the appropriate configuration so that the produced SDK knows how to find the configuration. The variable you need to set is :term:`SSTATE_MIRRORS`:: @@ -280,9 +281,8 @@ source, you need to do a number of things: ESDK_LOCALCONF_ALLOW = "SSTATE_MIRRORS" - Alternatively, if you just want to set the :term:`SSTATE_MIRRORS` - variable's value for the SDK alone, create a - ``conf/sdk-extra.conf`` file either in your - :term:`Build Directory` or within any + variable's value for the SDK alone, create a ``conf/sdk-extra.conf`` + file either in your :term:`Build Directory` or within any layer and put your :term:`SSTATE_MIRRORS` setting within that file. .. note:: |