summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual/sdk-appendix-customizing.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/sdk-manual/sdk-appendix-customizing.rst')
-rw-r--r--documentation/sdk-manual/sdk-appendix-customizing.rst50
1 files changed, 25 insertions, 25 deletions
diff --git a/documentation/sdk-manual/sdk-appendix-customizing.rst b/documentation/sdk-manual/sdk-appendix-customizing.rst
index 522b41033d..8169f2bed8 100644
--- a/documentation/sdk-manual/sdk-appendix-customizing.rst
+++ b/documentation/sdk-manual/sdk-appendix-customizing.rst
@@ -22,7 +22,7 @@ build system applies them against ``local.conf`` and ``auto.conf``:
22 host <&YOCTO_DOCS_REF_URL;#hardware-build-system-term>`__. 22 host <&YOCTO_DOCS_REF_URL;#hardware-build-system-term>`__.
23 23
24- Variables listed in 24- Variables listed in
25 ```SDK_LOCAL_CONF_BLACKLIST`` <&YOCTO_DOCS_REF_URL;#var-SDK_LOCAL_CONF_BLACKLIST>`__ 25 :term:`SDK_LOCAL_CONF_BLACKLIST`
26 are excluded. These variables are not allowed through from the 26 are excluded. These variables are not allowed through from the
27 OpenEmbedded build system configuration into the extensible SDK 27 OpenEmbedded build system configuration into the extensible SDK
28 configuration. Typically, these variables are specific to the machine 28 configuration. Typically, these variables are specific to the machine
@@ -30,23 +30,23 @@ build system applies them against ``local.conf`` and ``auto.conf``:
30 of the extensible SDK configuration. 30 of the extensible SDK configuration.
31 31
32 For a list of the variables excluded by default, see the 32 For a list of the variables excluded by default, see the
33 ```SDK_LOCAL_CONF_BLACKLIST`` <&YOCTO_DOCS_REF_URL;#var-SDK_LOCAL_CONF_BLACKLIST>`__ 33 :term:`SDK_LOCAL_CONF_BLACKLIST`
34 in the glossary of the Yocto Project Reference Manual. 34 in the glossary of the Yocto Project Reference Manual.
35 35
36- Variables listed in 36- Variables listed in
37 ```SDK_LOCAL_CONF_WHITELIST`` <&YOCTO_DOCS_REF_URL;#var-SDK_LOCAL_CONF_WHITELIST>`__ 37 :term:`SDK_LOCAL_CONF_WHITELIST`
38 are included. Including a variable in the value of 38 are included. Including a variable in the value of
39 ``SDK_LOCAL_CONF_WHITELIST`` overrides either of the previous two 39 ``SDK_LOCAL_CONF_WHITELIST`` overrides either of the previous two
40 filters. The default value is blank. 40 filters. The default value is blank.
41 41
42- Classes inherited globally with 42- Classes inherited globally with
43 ```INHERIT`` <&YOCTO_DOCS_REF_URL;#var-INHERIT>`__ that are listed in 43 :term:`INHERIT` that are listed in
44 ```SDK_INHERIT_BLACKLIST`` <&YOCTO_DOCS_REF_URL;#var-SDK_INHERIT_BLACKLIST>`__ 44 :term:`SDK_INHERIT_BLACKLIST`
45 are disabled. Using ``SDK_INHERIT_BLACKLIST`` to disable these 45 are disabled. Using ``SDK_INHERIT_BLACKLIST`` to disable these
46 classes is the typical method to disable classes that are problematic 46 classes is the typical method to disable classes that are problematic
47 or unnecessary in the SDK context. The default value blacklists the 47 or unnecessary in the SDK context. The default value blacklists the
48 ```buildhistory`` <&YOCTO_DOCS_REF_URL;#ref-classes-buildhistory>`__ 48 :ref:`buildhistory <ref-classes-buildhistory>`
49 and ```icecc`` <&YOCTO_DOCS_REF_URL;#ref-classes-icecc>`__ classes. 49 and :ref:`icecc <ref-classes-icecc>` classes.
50 50
51Additionally, the contents of ``conf/sdk-extra.conf``, when present, are 51Additionally, the contents of ``conf/sdk-extra.conf``, when present, are
52appended to the end of ``conf/local.conf`` within the produced SDK, 52appended to the end of ``conf/local.conf`` within the produced SDK,
@@ -63,10 +63,10 @@ However, some cases exist for which you might consider making
63adjustments: 63adjustments:
64 64
65- If your SDK configuration inherits additional classes using the 65- If your SDK configuration inherits additional classes using the
66 ```INHERIT`` <&YOCTO_DOCS_REF_URL;#var-INHERIT>`__ variable and you 66 :term:`INHERIT` variable and you
67 do not need or want those classes enabled in the SDK, you can 67 do not need or want those classes enabled in the SDK, you can
68 blacklist them by adding them to the 68 blacklist them by adding them to the
69 ```SDK_INHERIT_BLACKLIST`` <&YOCTO_DOCS_REF_URL;#var-SDK_INHERIT_BLACKLIST>`__ 69 :term:`SDK_INHERIT_BLACKLIST`
70 variable as described in the fourth bullet of the previous section. 70 variable as described in the fourth bullet of the previous section.
71 71
72 .. note:: 72 .. note::
@@ -93,7 +93,7 @@ adjustments:
93 state cache) or ensuring the tasks are able to be produced quickly 93 state cache) or ensuring the tasks are able to be produced quickly
94 from a task that is a shared state task, add the task name to the 94 from a task that is a shared state task, add the task name to the
95 value of 95 value of
96 ```SDK_RECRDEP_TASKS`` <&YOCTO_DOCS_REF_URL;#var-SDK_RECRDEP_TASKS>`__. 96 :term:`SDK_RECRDEP_TASKS`.
97 97
98 - Disable the tasks if they are added by a class and you do not need 98 - Disable the tasks if they are added by a class and you do not need
99 the functionality the class provides in the extensible SDK. To 99 the functionality the class provides in the extensible SDK. To
@@ -109,24 +109,24 @@ adjustments:
109 109
110- If you want users of the SDK to be able to easily update the SDK, you 110- If you want users of the SDK to be able to easily update the SDK, you
111 need to set the 111 need to set the
112 ```SDK_UPDATE_URL`` <&YOCTO_DOCS_REF_URL;#var-SDK_UPDATE_URL>`__ 112 :term:`SDK_UPDATE_URL`
113 variable. For more information, see the "`Providing Updates to the 113 variable. For more information, see the "`Providing Updates to the
114 Extensible SDK After 114 Extensible SDK After
115 Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__" 115 Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__"
116 section. 116 section.
117 117
118- If you have adjusted the list of files and directories that appear in 118- If you have adjusted the list of files and directories that appear in
119 ```COREBASE`` <&YOCTO_DOCS_REF_URL;#var-COREBASE>`__ (other than 119 :term:`COREBASE` (other than
120 layers that are enabled through ``bblayers.conf``), then you must 120 layers that are enabled through ``bblayers.conf``), then you must
121 list these files in 121 list these files in
122 ```COREBASE_FILES`` <&YOCTO_DOCS_REF_URL;#var-COREBASE_FILES>`__ so 122 :term:`COREBASE_FILES` so
123 that the files are copied into the SDK. 123 that the files are copied into the SDK.
124 124
125- If your OpenEmbedded build system setup uses a different environment 125- If your OpenEmbedded build system setup uses a different environment
126 setup script other than 126 setup script other than
127 ````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__, then you must 127 ````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__, then you must
128 set 128 set
129 ```OE_INIT_ENV_SCRIPT`` <&YOCTO_DOCS_REF_URL;#var-OE_INIT_ENV_SCRIPT>`__ 129 :term:`OE_INIT_ENV_SCRIPT`
130 to point to the environment setup script you use. 130 to point to the environment setup script you use.
131 131
132 .. note:: 132 .. note::
@@ -139,15 +139,15 @@ Changing the Extensible SDK Installer Title
139=========================================== 139===========================================
140 140
141You can change the displayed title for the SDK installer by setting the 141You can change the displayed title for the SDK installer by setting the
142```SDK_TITLE`` <&YOCTO_DOCS_REF_URL;#var-SDK_TITLE>`__ variable and then 142:term:`SDK_TITLE` variable and then
143rebuilding the the SDK installer. For information on how to build an SDK 143rebuilding the the SDK installer. For information on how to build an SDK
144installer, see the "`Building an SDK 144installer, see the "`Building an SDK
145Installer <#sdk-building-an-sdk-installer>`__" section. 145Installer <#sdk-building-an-sdk-installer>`__" section.
146 146
147By default, this title is derived from 147By default, this title is derived from
148```DISTRO_NAME`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_NAME>`__ when it is 148:term:`DISTRO_NAME` when it is
149set. If the ``DISTRO_NAME`` variable is not set, the title is derived 149set. If the ``DISTRO_NAME`` variable is not set, the title is derived
150from the ```DISTRO`` <&YOCTO_DOCS_REF_URL;#var-DISTRO>`__ variable. 150from the :term:`DISTRO` variable.
151 151
152The 152The
153```populate_sdk_base`` <&YOCTO_DOCS_REF_URL;#ref-classes-populate-sdk-*>`__ 153```populate_sdk_base`` <&YOCTO_DOCS_REF_URL;#ref-classes-populate-sdk-*>`__
@@ -181,7 +181,7 @@ the installed SDKs to update the installed SDKs by using the
181 to host the directory. This directory must contain the published SDK. 181 to host the directory. This directory must contain the published SDK.
182 182
1832. Set the 1832. Set the
184 ```SDK_UPDATE_URL`` <&YOCTO_DOCS_REF_URL;#var-SDK_UPDATE_URL>`__ 184 :term:`SDK_UPDATE_URL`
185 variable to point to the corresponding HTTP or HTTPS URL. Setting 185 variable to point to the corresponding HTTP or HTTPS URL. Setting
186 this variable causes any SDK built to default to that URL and thus, 186 this variable causes any SDK built to default to that URL and thus,
187 the user does not have to pass the URL to the ``devtool sdk-update`` 187 the user does not have to pass the URL to the ``devtool sdk-update``
@@ -209,8 +209,8 @@ Changing the Default SDK Installation Directory
209 209
210When you build the installer for the Extensible SDK, the default 210When you build the installer for the Extensible SDK, the default
211installation directory for the SDK is based on the 211installation directory for the SDK is based on the
212```DISTRO`` <&YOCTO_DOCS_REF_URL;#var-DISTRO>`__ and 212:term:`DISTRO` and
213```SDKEXTPATH`` <&YOCTO_DOCS_REF_URL;#var-SDKEXTPATH>`__ variables from 213:term:`SDKEXTPATH` variables from
214within the 214within the
215```populate_sdk_base`` <&YOCTO_DOCS_REF_URL;#ref-classes-populate-sdk-*>`__ 215```populate_sdk_base`` <&YOCTO_DOCS_REF_URL;#ref-classes-populate-sdk-*>`__
216class as follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" You can 216class as follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" You can
@@ -248,7 +248,7 @@ source, you need to do a number of things:
248 - Build the "world" target and set 248 - Build the "world" target and set
249 ``EXCLUDE_FROM_WORLD_pn-``\ recipename for the recipes you do not 249 ``EXCLUDE_FROM_WORLD_pn-``\ recipename for the recipes you do not
250 want built. See the 250 want built. See the
251 ```EXCLUDE_FROM_WORLD`` <&YOCTO_DOCS_REF_URL;#var-EXCLUDE_FROM_WORLD>`__ 251 :term:`EXCLUDE_FROM_WORLD`
252 variable for additional information. 252 variable for additional information.
253 253
2542. Expose the ``sstate-cache`` directory produced by the build. 2542. Expose the ``sstate-cache`` directory produced by the build.
@@ -259,7 +259,7 @@ source, you need to do a number of things:
259 259
2603. Set the appropriate configuration so that the produced SDK knows how 2603. Set the appropriate configuration so that the produced SDK knows how
261 to find the configuration. The variable you need to set is 261 to find the configuration. The variable you need to set is
262 ```SSTATE_MIRRORS`` <&YOCTO_DOCS_REF_URL;#var-SSTATE_MIRRORS>`__: 262 :term:`SSTATE_MIRRORS`:
263 SSTATE_MIRRORS = "file://.\* 263 SSTATE_MIRRORS = "file://.\*
264 http://example.com/some_path/sstate-cache/PATH" You can set the 264 http://example.com/some_path/sstate-cache/PATH" You can set the
265 ``SSTATE_MIRRORS`` variable in two different places: 265 ``SSTATE_MIRRORS`` variable in two different places:
@@ -297,7 +297,7 @@ more in size. If the size of this file causes a problem, you can build
297an SDK that has just enough in it to install and provide access to the 297an SDK that has just enough in it to install and provide access to the
298``devtool command`` by setting the following in your configuration: 298``devtool command`` by setting the following in your configuration:
299SDK_EXT_TYPE = "minimal" Setting 299SDK_EXT_TYPE = "minimal" Setting
300```SDK_EXT_TYPE`` <&YOCTO_DOCS_REF_URL;#var-SDK_EXT_TYPE>`__ to 300:term:`SDK_EXT_TYPE` to
301"minimal" produces an SDK installer that is around 35 Mbytes in size, 301"minimal" produces an SDK installer that is around 35 Mbytes in size,
302which downloads and installs quickly. You need to realize, though, that 302which downloads and installs quickly. You need to realize, though, that
303the minimal installer does not install any libraries or tools out of the 303the minimal installer does not install any libraries or tools out of the
@@ -315,7 +315,7 @@ results.
315 315
316To facilitate this wider range of information, you would need to set the 316To facilitate this wider range of information, you would need to set the
317following: SDK_INCLUDE_PKGDATA = "1" See the 317following: SDK_INCLUDE_PKGDATA = "1" See the
318```SDK_INCLUDE_PKGDATA`` <&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_PKGDATA>`__ 318:term:`SDK_INCLUDE_PKGDATA`
319variable for additional information. 319variable for additional information.
320 320
321Setting the ``SDK_INCLUDE_PKGDATA`` variable as shown causes the "world" 321Setting the ``SDK_INCLUDE_PKGDATA`` variable as shown causes the "world"
@@ -341,7 +341,7 @@ in most cases.
341 341
342You can explicitly control whether or not to include the toolchain when 342You can explicitly control whether or not to include the toolchain when
343you build an SDK by setting the 343you build an SDK by setting the
344```SDK_INCLUDE_TOOLCHAIN`` <&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN>`__ 344:term:`SDK_INCLUDE_TOOLCHAIN`
345variable to "1". In particular, it is useful to include the toolchain 345variable to "1". In particular, it is useful to include the toolchain
346when you have set ``SDK_EXT_TYPE`` to "minimal", which by default, 346when you have set ``SDK_EXT_TYPE`` to "minimal", which by default,
347excludes the toolchain. Also, it is helpful if you are building a small 347excludes the toolchain. Also, it is helpful if you are building a small