diff options
Diffstat (limited to 'documentation/sdk-manual')
| -rw-r--r-- | documentation/sdk-manual/sdk-appendix-customizing-standard.rst | 6 | ||||
| -rw-r--r-- | documentation/sdk-manual/sdk-appendix-customizing.rst | 50 | ||||
| -rw-r--r-- | documentation/sdk-manual/sdk-appendix-obtain.rst | 8 | ||||
| -rw-r--r-- | documentation/sdk-manual/sdk-extensible.rst | 64 | ||||
| -rw-r--r-- | documentation/sdk-manual/sdk-intro.rst | 10 | ||||
| -rw-r--r-- | documentation/sdk-manual/sdk-working-projects.rst | 4 |
6 files changed, 71 insertions, 71 deletions
diff --git a/documentation/sdk-manual/sdk-appendix-customizing-standard.rst b/documentation/sdk-manual/sdk-appendix-customizing-standard.rst index 02f7d764ca..f6f2b6640f 100644 --- a/documentation/sdk-manual/sdk-appendix-customizing-standard.rst +++ b/documentation/sdk-manual/sdk-appendix-customizing-standard.rst | |||
| @@ -11,9 +11,9 @@ Adding Individual Packages to the Standard SDK | |||
| 11 | 11 | ||
| 12 | When you build a standard SDK using the ``bitbake -c populate_sdk``, a | 12 | When you build a standard SDK using the ``bitbake -c populate_sdk``, a |
| 13 | default set of packages is included in the resulting SDK. The | 13 | default set of packages is included in the resulting SDK. The |
| 14 | ```TOOLCHAIN_HOST_TASK`` <&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK>`__ | 14 | :term:`TOOLCHAIN_HOST_TASK` |
| 15 | and | 15 | and |
| 16 | ```TOOLCHAIN_TARGET_TASK`` <&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK>`__ | 16 | :term:`TOOLCHAIN_TARGET_TASK` |
| 17 | variables control the set of packages adding to the SDK. | 17 | variables control the set of packages adding to the SDK. |
| 18 | 18 | ||
| 19 | If you want to add individual packages to the toolchain that runs on the | 19 | If you want to add individual packages to the toolchain that runs on the |
| @@ -28,7 +28,7 @@ Adding API Documentation to the Standard SDK | |||
| 28 | You can include API documentation as well as any other documentation | 28 | You can include API documentation as well as any other documentation |
| 29 | provided by recipes with the standard SDK by adding "api-documentation" | 29 | provided by recipes with the standard SDK by adding "api-documentation" |
| 30 | to the | 30 | to the |
| 31 | ```DISTRO_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES>`__ | 31 | :term:`DISTRO_FEATURES` |
| 32 | variable: DISTRO_FEATURES_append = " api-documentation" Setting this | 32 | variable: DISTRO_FEATURES_append = " api-documentation" Setting this |
| 33 | variable as shown here causes the OpenEmbedded build system to build the | 33 | variable as shown here causes the OpenEmbedded build system to build the |
| 34 | documentation and then include it in the standard SDK. | 34 | documentation and then include it in the standard SDK. |
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 | ||
| 51 | Additionally, the contents of ``conf/sdk-extra.conf``, when present, are | 51 | Additionally, the contents of ``conf/sdk-extra.conf``, when present, are |
| 52 | appended to the end of ``conf/local.conf`` within the produced SDK, | 52 | appended 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 | |||
| 63 | adjustments: | 63 | adjustments: |
| 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 | ||
| 141 | You can change the displayed title for the SDK installer by setting the | 141 | You 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 |
| 143 | rebuilding the the SDK installer. For information on how to build an SDK | 143 | rebuilding the the SDK installer. For information on how to build an SDK |
| 144 | installer, see the "`Building an SDK | 144 | installer, see the "`Building an SDK |
| 145 | Installer <#sdk-building-an-sdk-installer>`__" section. | 145 | Installer <#sdk-building-an-sdk-installer>`__" section. |
| 146 | 146 | ||
| 147 | By default, this title is derived from | 147 | By 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 |
| 149 | set. If the ``DISTRO_NAME`` variable is not set, the title is derived | 149 | set. If the ``DISTRO_NAME`` variable is not set, the title is derived |
| 150 | from the ```DISTRO`` <&YOCTO_DOCS_REF_URL;#var-DISTRO>`__ variable. | 150 | from the :term:`DISTRO` variable. |
| 151 | 151 | ||
| 152 | The | 152 | The |
| 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 | ||
| 183 | 2. Set the | 183 | 2. 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 | ||
| 210 | When you build the installer for the Extensible SDK, the default | 210 | When you build the installer for the Extensible SDK, the default |
| 211 | installation directory for the SDK is based on the | 211 | installation 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 |
| 214 | within the | 214 | within 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-*>`__ |
| 216 | class as follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" You can | 216 | class 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 | ||
| 254 | 2. Expose the ``sstate-cache`` directory produced by the build. | 254 | 2. Expose the ``sstate-cache`` directory produced by the build. |
| @@ -259,7 +259,7 @@ source, you need to do a number of things: | |||
| 259 | 259 | ||
| 260 | 3. Set the appropriate configuration so that the produced SDK knows how | 260 | 3. 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 | |||
| 297 | an SDK that has just enough in it to install and provide access to the | 297 | an 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: |
| 299 | SDK_EXT_TYPE = "minimal" Setting | 299 | SDK_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, |
| 302 | which downloads and installs quickly. You need to realize, though, that | 302 | which downloads and installs quickly. You need to realize, though, that |
| 303 | the minimal installer does not install any libraries or tools out of the | 303 | the minimal installer does not install any libraries or tools out of the |
| @@ -315,7 +315,7 @@ results. | |||
| 315 | 315 | ||
| 316 | To facilitate this wider range of information, you would need to set the | 316 | To facilitate this wider range of information, you would need to set the |
| 317 | following: SDK_INCLUDE_PKGDATA = "1" See the | 317 | following: SDK_INCLUDE_PKGDATA = "1" See the |
| 318 | ```SDK_INCLUDE_PKGDATA`` <&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_PKGDATA>`__ | 318 | :term:`SDK_INCLUDE_PKGDATA` |
| 319 | variable for additional information. | 319 | variable for additional information. |
| 320 | 320 | ||
| 321 | Setting the ``SDK_INCLUDE_PKGDATA`` variable as shown causes the "world" | 321 | Setting the ``SDK_INCLUDE_PKGDATA`` variable as shown causes the "world" |
| @@ -341,7 +341,7 @@ in most cases. | |||
| 341 | 341 | ||
| 342 | You can explicitly control whether or not to include the toolchain when | 342 | You can explicitly control whether or not to include the toolchain when |
| 343 | you build an SDK by setting the | 343 | you build an SDK by setting the |
| 344 | ```SDK_INCLUDE_TOOLCHAIN`` <&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN>`__ | 344 | :term:`SDK_INCLUDE_TOOLCHAIN` |
| 345 | variable to "1". In particular, it is useful to include the toolchain | 345 | variable to "1". In particular, it is useful to include the toolchain |
| 346 | when you have set ``SDK_EXT_TYPE`` to "minimal", which by default, | 346 | when you have set ``SDK_EXT_TYPE`` to "minimal", which by default, |
| 347 | excludes the toolchain. Also, it is helpful if you are building a small | 347 | excludes the toolchain. Also, it is helpful if you are building a small |
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.rst b/documentation/sdk-manual/sdk-appendix-obtain.rst index 1c69b3254d..c6efdf674c 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.rst +++ b/documentation/sdk-manual/sdk-appendix-obtain.rst | |||
| @@ -95,14 +95,14 @@ build the SDK installer. Follow these steps: | |||
| 95 | 95 | ||
| 96 | 4. *Make Sure You Are Building an Installer for the Correct Machine:* | 96 | 4. *Make Sure You Are Building an Installer for the Correct Machine:* |
| 97 | Check to be sure that your | 97 | Check to be sure that your |
| 98 | ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable in the | 98 | :term:`MACHINE` variable in the |
| 99 | ``local.conf`` file in your Build Directory matches the architecture | 99 | ``local.conf`` file in your Build Directory matches the architecture |
| 100 | for which you are building. | 100 | for which you are building. |
| 101 | 101 | ||
| 102 | 5. *Make Sure Your SDK Machine is Correctly Set:* If you are building a | 102 | 5. *Make Sure Your SDK Machine is Correctly Set:* If you are building a |
| 103 | toolchain designed to run on an architecture that differs from your | 103 | toolchain designed to run on an architecture that differs from your |
| 104 | current development host machine (i.e. the build host), be sure that | 104 | current development host machine (i.e. the build host), be sure that |
| 105 | the ```SDKMACHINE`` <&YOCTO_DOCS_REF_URL;#var-SDKMACHINE>`__ variable | 105 | the :term:`SDKMACHINE` variable |
| 106 | in the ``local.conf`` file in your Build Directory is correctly set. | 106 | in the ``local.conf`` file in your Build Directory is correctly set. |
| 107 | 107 | ||
| 108 | .. note:: | 108 | .. note:: |
| @@ -138,7 +138,7 @@ build the SDK installer. Follow these steps: | |||
| 138 | binaries. If you want to use the toolchain to build these types | 138 | binaries. If you want to use the toolchain to build these types |
| 139 | of libraries, you need to be sure your SDK has the appropriate | 139 | of libraries, you need to be sure your SDK has the appropriate |
| 140 | static development libraries. Use the | 140 | static development libraries. Use the |
| 141 | ```TOOLCHAIN_TARGET_TASK`` <&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK>`__ | 141 | :term:`TOOLCHAIN_TARGET_TASK` |
| 142 | variable inside your ``local.conf`` file before building the | 142 | variable inside your ``local.conf`` file before building the |
| 143 | SDK installer. Doing so ensures that the eventual SDK | 143 | SDK installer. Doing so ensures that the eventual SDK |
| 144 | installation process installs the appropriate library packages | 144 | installation process installs the appropriate library packages |
| @@ -189,7 +189,7 @@ Follow these steps to extract the root filesystem: | |||
| 189 | filesystem image's profile: lsb, lsb-dev, lsb-sdk, minimal, | 189 | filesystem image's profile: lsb, lsb-dev, lsb-sdk, minimal, |
| 190 | minimal-dev, minimal-initramfs, sato, sato-dev, sato-sdk, | 190 | minimal-dev, minimal-initramfs, sato, sato-dev, sato-sdk, |
| 191 | sato-sdk-ptest. For information on these types of image profiles, see | 191 | sato-sdk-ptest. For information on these types of image profiles, see |
| 192 | the "`Images <&YOCTO_DOCS_REF_URL;#ref-images>`__" chapter in the | 192 | the ":ref:`ref-manual/ref-images:Images`" chapter in the |
| 193 | Yocto Project Reference Manual. arch is a string representing the | 193 | Yocto Project Reference Manual. arch is a string representing the |
| 194 | target architecture: beaglebone-yocto, beaglebone-yocto-lsb, | 194 | target architecture: beaglebone-yocto, beaglebone-yocto-lsb, |
| 195 | edgerouter, edgerouter-lsb, genericx86, genericx86-64, | 195 | edgerouter, edgerouter-lsb, genericx86, genericx86-64, |
diff --git a/documentation/sdk-manual/sdk-extensible.rst b/documentation/sdk-manual/sdk-extensible.rst index cccc857d46..17cd08a25c 100644 --- a/documentation/sdk-manual/sdk-extensible.rst +++ b/documentation/sdk-manual/sdk-extensible.rst | |||
| @@ -148,8 +148,8 @@ SDK environment now set up; additionally you may now run devtool to | |||
| 148 | perform development tasks. Run devtool --help for further details. | 148 | perform development tasks. Run devtool --help for further details. |
| 149 | Running the setup script defines many environment variables needed in | 149 | Running the setup script defines many environment variables needed in |
| 150 | order to use the SDK (e.g. ``PATH``, | 150 | order to use the SDK (e.g. ``PATH``, |
| 151 | ```CC`` <&YOCTO_DOCS_REF_URL;#var-CC>`__, | 151 | :term:`CC`, |
| 152 | ```LD`` <&YOCTO_DOCS_REF_URL;#var-LD>`__, and so forth). If you want to | 152 | :term:`LD`, and so forth). If you want to |
| 153 | see all the environment variables the script exports, examine the | 153 | see all the environment variables the script exports, examine the |
| 154 | installation file itself. | 154 | installation file itself. |
| 155 | 155 | ||
| @@ -215,7 +215,7 @@ Use ``devtool add`` to Add an Application | |||
| 215 | 215 | ||
| 216 | The ``devtool add`` command generates a new recipe based on existing | 216 | The ``devtool add`` command generates a new recipe based on existing |
| 217 | source code. This command takes advantage of the | 217 | source code. This command takes advantage of the |
| 218 | `workspace <&YOCTO_DOCS_REF_URL;#devtool-the-workspace-layer-structure>`__ | 218 | :ref:`devtool-the-workspace-layer-structure` |
| 219 | layer that many ``devtool`` commands use. The command is flexible enough | 219 | layer that many ``devtool`` commands use. The command is flexible enough |
| 220 | to allow you to extract source code into both the workspace or a | 220 | to allow you to extract source code into both the workspace or a |
| 221 | separate local Git repository and to use existing code that does not | 221 | separate local Git repository and to use existing code that does not |
| @@ -397,7 +397,7 @@ command: | |||
| 397 | The following command identifies the recipe and, by default, | 397 | The following command identifies the recipe and, by default, |
| 398 | extracts the source files: $ devtool modify recipe Once | 398 | extracts the source files: $ devtool modify recipe Once |
| 399 | ``devtool``\ locates the recipe, ``devtool`` uses the recipe's | 399 | ``devtool``\ locates the recipe, ``devtool`` uses the recipe's |
| 400 | ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statements to | 400 | :term:`SRC_URI` statements to |
| 401 | locate the source code and any local patch files from other | 401 | locate the source code and any local patch files from other |
| 402 | developers. | 402 | developers. |
| 403 | 403 | ||
| @@ -569,7 +569,7 @@ counterparts. | |||
| 569 | The ``devtool upgrade`` command is flexible enough to allow you to | 569 | The ``devtool upgrade`` command is flexible enough to allow you to |
| 570 | specify source code revision and versioning schemes, extract code into | 570 | specify source code revision and versioning schemes, extract code into |
| 571 | or out of the ``devtool`` | 571 | or out of the ``devtool`` |
| 572 | `workspace <&YOCTO_DOCS_REF_URL;#devtool-the-workspace-layer-structure>`__, | 572 | :ref:`devtool-the-workspace-layer-structure`, |
| 573 | and work with any source file forms that the | 573 | and work with any source file forms that the |
| 574 | `fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ support. | 574 | `fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ support. |
| 575 | 575 | ||
| @@ -584,7 +584,7 @@ The following diagram shows the common development flow used with the | |||
| 584 | workspace. | 584 | workspace. |
| 585 | 585 | ||
| 586 | - The source files for the new release exist in the same location | 586 | - The source files for the new release exist in the same location |
| 587 | pointed to by ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ | 587 | pointed to by :term:`SRC_URI` |
| 588 | in the recipe (e.g. a tarball with the new version number in the | 588 | in the recipe (e.g. a tarball with the new version number in the |
| 589 | name, or as a different revision in the upstream Git repository). | 589 | name, or as a different revision in the upstream Git repository). |
| 590 | 590 | ||
| @@ -594,7 +594,7 @@ The following diagram shows the common development flow used with the | |||
| 594 | use the newer version of the software: $ devtool upgrade -V version | 594 | use the newer version of the software: $ devtool upgrade -V version |
| 595 | recipe By default, the ``devtool upgrade`` command extracts source | 595 | recipe By default, the ``devtool upgrade`` command extracts source |
| 596 | code into the ``sources`` directory in the | 596 | code into the ``sources`` directory in the |
| 597 | `workspace <&YOCTO_DOCS_REF_URL;#devtool-the-workspace-layer-structure>`__. | 597 | :ref:`devtool-the-workspace-layer-structure`. |
| 598 | If you want the code extracted to any other location, you need to | 598 | If you want the code extracted to any other location, you need to |
| 599 | provide the srctree positional argument with the command as follows: | 599 | provide the srctree positional argument with the command as follows: |
| 600 | $ devtool upgrade -V version recipe srctree | 600 | $ devtool upgrade -V version recipe srctree |
| @@ -773,7 +773,7 @@ Dependency Detection and Mapping | |||
| 773 | The ``devtool add`` command attempts to detect build-time dependencies | 773 | The ``devtool add`` command attempts to detect build-time dependencies |
| 774 | and map them to other recipes in the system. During this mapping, the | 774 | and map them to other recipes in the system. During this mapping, the |
| 775 | command fills in the names of those recipes as part of the | 775 | command fills in the names of those recipes as part of the |
| 776 | ```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ variable within the | 776 | :term:`DEPENDS` variable within the |
| 777 | recipe. If a dependency cannot be mapped, ``devtool`` places a comment | 777 | recipe. If a dependency cannot be mapped, ``devtool`` places a comment |
| 778 | in the recipe indicating such. The inability to map a dependency can | 778 | in the recipe indicating such. The inability to map a dependency can |
| 779 | result from naming not being recognized or because the dependency simply | 779 | result from naming not being recognized or because the dependency simply |
| @@ -807,13 +807,13 @@ License Detection | |||
| 807 | The ``devtool add`` command attempts to determine if the software you | 807 | The ``devtool add`` command attempts to determine if the software you |
| 808 | are adding is able to be distributed under a common, open-source | 808 | are adding is able to be distributed under a common, open-source |
| 809 | license. If so, the command sets the | 809 | license. If so, the command sets the |
| 810 | ```LICENSE`` <&YOCTO_DOCS_REF_URL;#var-LICENSE>`__ value accordingly. | 810 | :term:`LICENSE` value accordingly. |
| 811 | You should double-check the value added by the command against the | 811 | You should double-check the value added by the command against the |
| 812 | documentation or source files for the software you are building and, if | 812 | documentation or source files for the software you are building and, if |
| 813 | necessary, update that ``LICENSE`` value. | 813 | necessary, update that ``LICENSE`` value. |
| 814 | 814 | ||
| 815 | The ``devtool add`` command also sets the | 815 | The ``devtool add`` command also sets the |
| 816 | ```LIC_FILES_CHKSUM`` <&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM>`__ | 816 | :term:`LIC_FILES_CHKSUM` |
| 817 | value to point to all files that appear to be license-related. Realize | 817 | value to point to all files that appear to be license-related. Realize |
| 818 | that license statements often appear in comments at the top of source | 818 | that license statements often appear in comments at the top of source |
| 819 | files or within the documentation. In such cases, the command does not | 819 | files or within the documentation. In such cases, the command does not |
| @@ -842,7 +842,7 @@ open-source software. Unfortunately, Makefiles are often not written | |||
| 842 | with cross-compilation in mind. Thus, ``devtool add`` often cannot do | 842 | with cross-compilation in mind. Thus, ``devtool add`` often cannot do |
| 843 | very much to ensure that these Makefiles build correctly. It is very | 843 | very much to ensure that these Makefiles build correctly. It is very |
| 844 | common, for example, to explicitly call ``gcc`` instead of using the | 844 | common, for example, to explicitly call ``gcc`` instead of using the |
| 845 | ```CC`` <&YOCTO_DOCS_REF_URL;#var-CC>`__ variable. Usually, in a | 845 | :term:`CC` variable. Usually, in a |
| 846 | cross-compilation environment, ``gcc`` is the compiler for the build | 846 | cross-compilation environment, ``gcc`` is the compiler for the build |
| 847 | host and the cross-compiler is named something similar to | 847 | host and the cross-compiler is named something similar to |
| 848 | ``arm-poky-linux-gnueabi-gcc`` and might require arguments (e.g. to | 848 | ``arm-poky-linux-gnueabi-gcc`` and might require arguments (e.g. to |
| @@ -869,8 +869,8 @@ mind: | |||
| 869 | sets the default using the "?=" operator, or you can alternatively | 869 | sets the default using the "?=" operator, or you can alternatively |
| 870 | force the value on the ``make`` command line. To force the value on | 870 | force the value on the ``make`` command line. To force the value on |
| 871 | the command line, add the variable setting to | 871 | the command line, add the variable setting to |
| 872 | ```EXTRA_OEMAKE`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE>`__ or | 872 | :term:`EXTRA_OEMAKE` or |
| 873 | ```PACKAGECONFIG_CONFARGS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS>`__ | 873 | :term:`PACKAGECONFIG_CONFARGS` |
| 874 | within the recipe. Here is an example using ``EXTRA_OEMAKE``: | 874 | within the recipe. Here is an example using ``EXTRA_OEMAKE``: |
| 875 | EXTRA_OEMAKE += "'CC=${CC}' 'CXX=${CXX}'" In the above example, | 875 | EXTRA_OEMAKE += "'CC=${CC}' 'CXX=${CXX}'" In the above example, |
| 876 | single quotes are used around the variable settings as the values are | 876 | single quotes are used around the variable settings as the values are |
| @@ -951,7 +951,7 @@ repository or local source tree. To add modules this way, use | |||
| 951 | https://github.com/diversario/node-ssdp In this example, ``devtool`` | 951 | https://github.com/diversario/node-ssdp In this example, ``devtool`` |
| 952 | fetches the specified Git repository, detects the code as Node.js code, | 952 | fetches the specified Git repository, detects the code as Node.js code, |
| 953 | fetches dependencies using ``npm``, and sets | 953 | fetches dependencies using ``npm``, and sets |
| 954 | ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ accordingly. | 954 | :term:`SRC_URI` accordingly. |
| 955 | 955 | ||
| 956 | .. _sdk-working-with-recipes: | 956 | .. _sdk-working-with-recipes: |
| 957 | 957 | ||
| @@ -976,8 +976,8 @@ build progresses as follows: | |||
| 976 | For recipes in the workspace, fetching and unpacking is disabled as the | 976 | For recipes in the workspace, fetching and unpacking is disabled as the |
| 977 | source tree has already been prepared and is persistent. Each of these | 977 | source tree has already been prepared and is persistent. Each of these |
| 978 | build steps is defined as a function (task), usually with a "do_" prefix | 978 | build steps is defined as a function (task), usually with a "do_" prefix |
| 979 | (e.g. ```do_fetch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-fetch>`__, | 979 | (e.g. :ref:`ref-tasks-fetch`, |
| 980 | ```do_unpack`` <&YOCTO_DOCS_REF_URL;#ref-tasks-unpack>`__, and so | 980 | :ref:`ref-tasks-unpack`, and so |
| 981 | forth). These functions are typically shell scripts but can instead be | 981 | forth). These functions are typically shell scripts but can instead be |
| 982 | written in Python. | 982 | written in Python. |
| 983 | 983 | ||
| @@ -986,7 +986,7 @@ does not include complete instructions for building the software. | |||
| 986 | Instead, common functionality is encapsulated in classes inherited with | 986 | Instead, common functionality is encapsulated in classes inherited with |
| 987 | the ``inherit`` directive. This technique leaves the recipe to describe | 987 | the ``inherit`` directive. This technique leaves the recipe to describe |
| 988 | just the things that are specific to the software being built. A | 988 | just the things that are specific to the software being built. A |
| 989 | ```base`` <&YOCTO_DOCS_REF_URL;#ref-classes-base>`__ class exists that | 989 | :ref:`base <ref-classes-base>` class exists that |
| 990 | is implicitly inherited by all recipes and provides the functionality | 990 | is implicitly inherited by all recipes and provides the functionality |
| 991 | that most recipes typically need. | 991 | that most recipes typically need. |
| 992 | 992 | ||
| @@ -1011,9 +1011,9 @@ links created within the source tree: | |||
| 1011 | useful: | 1011 | useful: |
| 1012 | 1012 | ||
| 1013 | - ``image/``: Contains all of the files installed during the | 1013 | - ``image/``: Contains all of the files installed during the |
| 1014 | ```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ stage. | 1014 | :ref:`ref-tasks-install` stage. |
| 1015 | Within a recipe, this directory is referred to by the expression | 1015 | Within a recipe, this directory is referred to by the expression |
| 1016 | ``${``\ ```D`` <&YOCTO_DOCS_REF_URL;#var-D>`__\ ``}``. | 1016 | ``${``\ :term:`D`\ ``}``. |
| 1017 | 1017 | ||
| 1018 | - ``sysroot-destdir/``: Contains a subset of files installed within | 1018 | - ``sysroot-destdir/``: Contains a subset of files installed within |
| 1019 | ``do_install`` that have been put into the shared sysroot. For | 1019 | ``do_install`` that have been put into the shared sysroot. For |
| @@ -1035,16 +1035,16 @@ Setting Configure Arguments | |||
| 1035 | If the software your recipe is building uses GNU autoconf, then a fixed | 1035 | If the software your recipe is building uses GNU autoconf, then a fixed |
| 1036 | set of arguments is passed to it to enable cross-compilation plus any | 1036 | set of arguments is passed to it to enable cross-compilation plus any |
| 1037 | extras specified by | 1037 | extras specified by |
| 1038 | ```EXTRA_OECONF`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF>`__ or | 1038 | :term:`EXTRA_OECONF` or |
| 1039 | ```PACKAGECONFIG_CONFARGS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS>`__ | 1039 | :term:`PACKAGECONFIG_CONFARGS` |
| 1040 | set within the recipe. If you wish to pass additional options, add them | 1040 | set within the recipe. If you wish to pass additional options, add them |
| 1041 | to ``EXTRA_OECONF`` or ``PACKAGECONFIG_CONFARGS``. Other supported build | 1041 | to ``EXTRA_OECONF`` or ``PACKAGECONFIG_CONFARGS``. Other supported build |
| 1042 | tools have similar variables (e.g. | 1042 | tools have similar variables (e.g. |
| 1043 | ```EXTRA_OECMAKE`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_OECMAKE>`__ for | 1043 | :term:`EXTRA_OECMAKE` for |
| 1044 | CMake, ```EXTRA_OESCONS`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_OESCONS>`__ | 1044 | CMake, :term:`EXTRA_OESCONS` |
| 1045 | for Scons, and so forth). If you need to pass anything on the ``make`` | 1045 | for Scons, and so forth). If you need to pass anything on the ``make`` |
| 1046 | command line, you can use ``EXTRA_OEMAKE`` or the | 1046 | command line, you can use ``EXTRA_OEMAKE`` or the |
| 1047 | ```PACKAGECONFIG_CONFARGS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS>`__ | 1047 | :term:`PACKAGECONFIG_CONFARGS` |
| 1048 | variables to do so. | 1048 | variables to do so. |
| 1049 | 1049 | ||
| 1050 | You can use the ``devtool configure-help`` command to help you set the | 1050 | You can use the ``devtool configure-help`` command to help you set the |
| @@ -1071,8 +1071,8 @@ the build host. | |||
| 1071 | 1071 | ||
| 1072 | Recipes should never write files directly into the sysroot. Instead, | 1072 | Recipes should never write files directly into the sysroot. Instead, |
| 1073 | files should be installed into standard locations during the | 1073 | files should be installed into standard locations during the |
| 1074 | ```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ task within | 1074 | :ref:`ref-tasks-install` task within |
| 1075 | the ``${``\ ```D`` <&YOCTO_DOCS_REF_URL;#var-D>`__\ ``}`` directory. A | 1075 | the ``${``\ :term:`D`\ ``}`` directory. A |
| 1076 | subset of these files automatically goes into the sysroot. The reason | 1076 | subset of these files automatically goes into the sysroot. The reason |
| 1077 | for this limitation is that almost all files that go into the sysroot | 1077 | for this limitation is that almost all files that go into the sysroot |
| 1078 | are cataloged in manifests in order to ensure they can be removed later | 1078 | are cataloged in manifests in order to ensure they can be removed later |
| @@ -1090,9 +1090,9 @@ the target device, it is important to understand packaging because the | |||
| 1090 | contents of the image are expressed in terms of packages and not | 1090 | contents of the image are expressed in terms of packages and not |
| 1091 | recipes. | 1091 | recipes. |
| 1092 | 1092 | ||
| 1093 | During the ```do_package`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package>`__ | 1093 | During the :ref:`ref-tasks-package` |
| 1094 | task, files installed during the | 1094 | task, files installed during the |
| 1095 | ```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ task are | 1095 | :ref:`ref-tasks-install` task are |
| 1096 | split into one main package, which is almost always named the same as | 1096 | split into one main package, which is almost always named the same as |
| 1097 | the recipe, and into several other packages. This separation exists | 1097 | the recipe, and into several other packages. This separation exists |
| 1098 | because not all of those installed files are useful in every image. For | 1098 | because not all of those installed files are useful in every image. For |
| @@ -1105,14 +1105,14 @@ package splitting as well. | |||
| 1105 | After building a recipe, you can see where files have gone by looking in | 1105 | After building a recipe, you can see where files have gone by looking in |
| 1106 | the ``oe-workdir/packages-split`` directory, which contains a | 1106 | the ``oe-workdir/packages-split`` directory, which contains a |
| 1107 | subdirectory for each package. Apart from some advanced cases, the | 1107 | subdirectory for each package. Apart from some advanced cases, the |
| 1108 | ```PACKAGES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGES>`__ and | 1108 | :term:`PACKAGES` and |
| 1109 | ```FILES`` <&YOCTO_DOCS_REF_URL;#var-FILES>`__ variables controls | 1109 | :term:`FILES` variables controls |
| 1110 | splitting. The ``PACKAGES`` variable lists all of the packages to be | 1110 | splitting. The ``PACKAGES`` variable lists all of the packages to be |
| 1111 | produced, while the ``FILES`` variable specifies which files to include | 1111 | produced, while the ``FILES`` variable specifies which files to include |
| 1112 | in each package by using an override to specify the package. For | 1112 | in each package by using an override to specify the package. For |
| 1113 | example, ``FILES_${PN}`` specifies the files to go into the main package | 1113 | example, ``FILES_${PN}`` specifies the files to go into the main package |
| 1114 | (i.e. the main package has the same name as the recipe and | 1114 | (i.e. the main package has the same name as the recipe and |
| 1115 | ``${``\ ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__\ ``}`` evaluates to the | 1115 | ``${``\ :term:`PN`\ ``}`` evaluates to the |
| 1116 | recipe name). The order of the ``PACKAGES`` value is significant. For | 1116 | recipe name). The order of the ``PACKAGES`` value is significant. For |
| 1117 | each installed file, the first package whose ``FILES`` value matches the | 1117 | each installed file, the first package whose ``FILES`` value matches the |
| 1118 | file is the package into which the file goes. Defaults exist for both | 1118 | file is the package into which the file goes. Defaults exist for both |
| @@ -1190,7 +1190,7 @@ manually "pull down" the updates into the installed SDK. | |||
| 1190 | To update your installed SDK, use ``devtool`` as follows: $ devtool | 1190 | To update your installed SDK, use ``devtool`` as follows: $ devtool |
| 1191 | sdk-update The previous command assumes your SDK provider has set the | 1191 | sdk-update The previous command assumes your SDK provider has set the |
| 1192 | default update URL for you through the | 1192 | default update URL for you through the |
| 1193 | ```SDK_UPDATE_URL`` <&YOCTO_DOCS_REF_URL;#var-SDK_UPDATE_URL>`__ | 1193 | :term:`SDK_UPDATE_URL` |
| 1194 | variable as described in the "`Providing Updates to the Extensible SDK | 1194 | variable as described in the "`Providing Updates to the Extensible SDK |
| 1195 | After | 1195 | After |
| 1196 | Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__" | 1196 | Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__" |
diff --git a/documentation/sdk-manual/sdk-intro.rst b/documentation/sdk-manual/sdk-intro.rst index 1a07a9e7a9..fcb15a8592 100644 --- a/documentation/sdk-manual/sdk-intro.rst +++ b/documentation/sdk-manual/sdk-intro.rst | |||
| @@ -56,8 +56,8 @@ toolchain binaries are produced for any given architecture. This feature | |||
| 56 | takes advantage of the fact that the target hardware can be passed to | 56 | takes advantage of the fact that the target hardware can be passed to |
| 57 | ``gcc`` as a set of compiler options. Those options are set up by the | 57 | ``gcc`` as a set of compiler options. Those options are set up by the |
| 58 | environment script and contained in variables such as | 58 | environment script and contained in variables such as |
| 59 | ```CC`` <&YOCTO_DOCS_REF_URL;#var-CC>`__ and | 59 | :term:`CC` and |
| 60 | ```LD`` <&YOCTO_DOCS_REF_URL;#var-LD>`__. This reduces the space needed | 60 | :term:`LD`. This reduces the space needed |
| 61 | for the tools. Understand, however, that every target still needs a | 61 | for the tools. Understand, however, that every target still needs a |
| 62 | sysroot because those binaries are target-specific. | 62 | sysroot because those binaries are target-specific. |
| 63 | 63 | ||
| @@ -66,7 +66,7 @@ The SDK development environment consists of the following: | |||
| 66 | - The self-contained SDK, which is an architecture-specific | 66 | - The self-contained SDK, which is an architecture-specific |
| 67 | cross-toolchain and matching sysroots (target and native) all built | 67 | cross-toolchain and matching sysroots (target and native) all built |
| 68 | by the OpenEmbedded build system (e.g. the SDK). The toolchain and | 68 | by the OpenEmbedded build system (e.g. the SDK). The toolchain and |
| 69 | sysroots are based on a `Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ | 69 | sysroots are based on a :term:`Metadata` |
| 70 | configuration and extensions, which allows you to cross-develop on | 70 | configuration and extensions, which allows you to cross-develop on |
| 71 | the host machine for the target hardware. Additionally, the | 71 | the host machine for the target hardware. Additionally, the |
| 72 | extensible SDK contains the ``devtool`` functionality. | 72 | extensible SDK contains the ``devtool`` functionality. |
| @@ -107,9 +107,9 @@ when considering which to build: | |||
| 107 | +-----------------------+-----------------------+-----------------------+ | 107 | +-----------------------+-----------------------+-----------------------+ |
| 108 | 108 | ||
| 109 | \* Extensible SDK contains the toolchain and debugger if | 109 | \* Extensible SDK contains the toolchain and debugger if |
| 110 | ```SDK_EXT_TYPE`` <&YOCTO_DOCS_REF_URL;#var-SDK_EXT_TYPE>`__ is "full" | 110 | :term:`SDK_EXT_TYPE` is "full" |
| 111 | or | 111 | or |
| 112 | ```SDK_INCLUDE_TOOLCHAIN`` <&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN>`__ | 112 | :term:`SDK_INCLUDE_TOOLCHAIN` |
| 113 | is "1", which is the default. \*\* Sysroot is managed through the use of | 113 | is "1", which is the default. \*\* Sysroot is managed through the use of |
| 114 | ``devtool``. Thus, it is less likely that you will corrupt your SDK | 114 | ``devtool``. Thus, it is less likely that you will corrupt your SDK |
| 115 | sysroot when you try to add additional libraries. \**\* You can add | 115 | sysroot when you try to add additional libraries. \**\* You can add |
diff --git a/documentation/sdk-manual/sdk-working-projects.rst b/documentation/sdk-manual/sdk-working-projects.rst index 1d001d1099..63f61de66d 100644 --- a/documentation/sdk-manual/sdk-working-projects.rst +++ b/documentation/sdk-manual/sdk-working-projects.rst | |||
| @@ -79,7 +79,7 @@ project: | |||
| 79 | 79 | ||
| 80 | 4. *Cross-Compile the Project:* This command compiles the project using | 80 | 4. *Cross-Compile the Project:* This command compiles the project using |
| 81 | the cross-compiler. The | 81 | the cross-compiler. The |
| 82 | ```CONFIGURE_FLAGS`` <&YOCTO_DOCS_REF_URL;#var-CONFIGURE_FLAGS>`__ | 82 | :term:`CONFIGURE_FLAGS` |
| 83 | environment variable provides the minimal arguments for GNU | 83 | environment variable provides the minimal arguments for GNU |
| 84 | configure: $ ./configure ${CONFIGURE_FLAGS} For an Autotools-based | 84 | configure: $ ./configure ${CONFIGURE_FLAGS} For an Autotools-based |
| 85 | project, you can use the cross-toolchain by just passing the | 85 | project, you can use the cross-toolchain by just passing the |
| @@ -167,7 +167,7 @@ demonstrates these variable behaviors. | |||
| 167 | In a new shell environment variables are not established for the SDK | 167 | In a new shell environment variables are not established for the SDK |
| 168 | until you run the setup script. For example, the following commands show | 168 | until you run the setup script. For example, the following commands show |
| 169 | a null value for the compiler variable (i.e. | 169 | a null value for the compiler variable (i.e. |
| 170 | ```CC`` <&YOCTO_DOCS_REF_URL;#var-CC>`__). $ echo ${CC} $ Running the | 170 | :term:`CC`). $ echo ${CC} $ Running the |
| 171 | SDK setup script for a 64-bit build host and an i586-tuned target | 171 | SDK setup script for a 64-bit build host and an i586-tuned target |
| 172 | architecture for a ``core-image-sato`` image using the current DISTRO | 172 | architecture for a ``core-image-sato`` image using the current DISTRO |
| 173 | Yocto Project release and then echoing that variable shows the value | 173 | Yocto Project release and then echoing that variable shows the value |
