summaryrefslogtreecommitdiff
path: root/poky/documentation/sdk-manual/sdk-appendix-customizing.rst
diff options
context:
space:
mode:
authorAndrew Geissler <geissonator@yahoo.com>2020-12-13 17:44:15 +0300
committerAndrew Geissler <geissonator@yahoo.com>2020-12-15 21:53:47 +0300
commit09209eec235a35b7089db987561c12e9bd023237 (patch)
tree2d3580484ffacafe11b72e9abaab50a428dd617d /poky/documentation/sdk-manual/sdk-appendix-customizing.rst
parentf7ba29eda266e04f867e4338b6b8b10c1969419c (diff)
downloadopenbmc-09209eec235a35b7089db987561c12e9bd023237.tar.xz
poky: subtree update:0ac99625bf..796be0593a
Alexander Kanavin (31): netbase: upgrade 6.1 -> 6.2 meson: upgrade 0.55.1 -> 0.56.0 vulkan-samples: update to latest revision libcap: update 2.44 -> 2.45 bind: upgrade 9.16.7 -> 9.16.9 quota: upgrade 4.05 -> 4.06 pango: upgrade 1.46.2 -> 1.48.0 elfutils: upgrade 0.181 -> 0.182 ifupdown: upgrade 0.8.35 -> 0.8.36 createrepo-c: upgrade 0.16.1 -> 0.16.2 acpica: upgrade 20200925 -> 20201113 grep: upgrade 3.5 -> 3.6 man-pages: upgrade 5.08 -> 5.09 stress-ng: upgrade 0.11.23 -> 0.11.24 libhandy: upgrade 1.0.1 -> 1.0.2 piglit: upgrade to latest revision xkbcomp: upgrade 1.4.3 -> 1.4.4 lz4: upgrade 1.9.2 -> 1.9.3 bison: upgrade 3.7.3 -> 3.7.4 python3-setuptools-scm: fix upstream version check cantarell-fonts: update 0.0.25 -> 0.201 meta/lib/oe/reproducible.py: gitsm:// works just as fine as git:// for timestamps llvm: fix reproducibility ruby: fix reproducibility webkitgtk: fix reproducibility ffmpeg: fix reproducibility piglit: fix reproducibility serf: do not install the static library llvm: sort the lists in generated source reproducibibly kea: fix reproducibility poky.conf: do not write current date into distro version, use git hash instead Andrej Valek (1): kernel-dummy: fix executing unexpected tasks Anuj Mittal (1): releases.rst: add gatesgarth to current releases Brett Warren (1): libffi: add patch to revert clang VFP workaround Chandana kalluri (1): populate_sdk_ext: use SDK_CUSTOM_TEPLATECONF variable to enable custom templateconf.cfg Changqing Li (1): buildtools-tarball: add wic dependency into extended buildtools Diego Sueiro (2): modutils-initscripts: Fix modules.dep creation when USE_DEPMOD="0" initscripts: Change execution order between checkroot and modutils Dmitry Baryshkov (2): linux-firmware: upgrade 20201022 -> 20201118 linux-firmware: package ath11k firmware Fabio Berton (1): mesa: Update 20.2.1 -> 20.2.4 Gratian Crisan (1): kernel-module-split.bbclass: fix kernel modules getting marked as CONFFILES Jack Mitchell (3): Revert "connman: set service to conflict with systemd-networkd" systemd-conf: add PACKAGECONFIG to enable/disable auto ethernet DHCP systemd-conf: match ethernet interfaces by type rather than globbing Joshua Watt (2): bitbake: hashserv: client: Fix AF_UNIX path length limits bitbake: hashserv: Fix broken AF_UNIX path length limit Kai Kang (2): systemd-systemctl-native: capable to call without argument systemd.bbclass: update command to check systemctl available Kevin Hao (1): tune-octeontx2.inc: Add tune for Marvell OCTEON TX2 core Li Wang (2): qemu: CVE-2020-29129 CVE-2020-29130 qemu: CVE-2020-25624 Luca Boccassi (1): dbus: move messagebus user to dbus-common package Michael Halstead (1): releases: conf: add link to 3.1.4, update to include 3.1.4 Nicolas Dechesne (19): sphinx: add .vscode in .gitignore {dev,kernel,sdk}-manual: replace hardcoded release version with &DISTRO; sphinx: replace bitbake labels with references to corresponding title brief-yoctoprojectqs: replace labels with references to section title dev-manual: replace labels with references to section title ref-manual: replace labels with references to section title sdk-manual: replace labels with references to section title overview-manual: remove unused labels dev-manual: remove unused labels sphinx: rename top level document in each manual sphinx: use absolute paths for :doc: references test-manual: remove 'test-manual' from filenames toaster-manual: remove 'toaster-manual' from filenames dev-manual: remove 'dev-manual' from filenames kernel-dev: remove 'kernel-dev' from filenames profile-manual: remove 'profile-manual' from filenames overview-manual: remove 'overview-manual' from filenames sdk-manual: remove 'sdk' from filenames ref-manual: remove 'ref' from filenames Paul Barker (5): documentation: Simplify yocto_wiki links documentation: Simplify yocto_git links ref-manual: Simplify oe_git links poky.conf: Add opensuseleap-15.2 and fedora-33 to tested distros poky.conf: Drop fedora-30 from tested distros Peter Kjellerstedt (2): pseudo: Simplify pseudo_client_ignore_path_chroot() bitbake.conf: Add all layers (from BBLAYERS) to PSEUDO_IGNORE_PATHS Richard Purdie (8): lz4: Use the new branch naming from upstream Revert "bitbake.conf: Add all layers (from BBLAYERS) to PSEUDO_IGNORE_PATHS" build-appliance-image: Update to master head revision bitbake: Revert "fetch2: use relative symlinks for anything pulled from PREMIRRORS" build-appliance-image: Update to master head revision metadata_scm: Fix signature handling of METADATA_REVISION and METADATA_BRANCH poky: Set SDK_VERSION explicitly build-appliance-image: Update to master head revision Ross Burton (9): oeqa/devtool: use Yocto mirror for pv-1.5.3 tarball image_types: remove obsolete tar comment image_types: sort tarball file listings package_manager/ipk: neaten OPKGLIBDIR logic ldconfig-native: don't write auxiliary cache package_manager/ipk: improve remove_packaging_data oeqa/selftest/containerimage: update for improved cleanup coreutils: add SUSE-specific issues to CVE whitelist bitbake: msg: use safe YAML loader Sinan Kaya (1): poky-tiny: enable section removal Tomasz Dziendzielski (1): pseudo: Update to print PSEUDO_LOGFILE in abort message on path mismatches sangeeta jain (1): meta/lib/oeqa/manual/oe-core.json: Update test_bitbake_devshell zangrc (3): libinput: upgrade 1.16.3 -> 1.16.4 lighttpd: upgrade 1.4.55 -> 1.4.56 sysstat: upgrade 12.4.0 -> 12.4.1 Signed-off-by: Andrew Geissler <geissonator@yahoo.com> Change-Id: I65f2f1c9d44433f3e62609240012c42256679b51
Diffstat (limited to 'poky/documentation/sdk-manual/sdk-appendix-customizing.rst')
-rw-r--r--poky/documentation/sdk-manual/sdk-appendix-customizing.rst377
1 files changed, 0 insertions, 377 deletions
diff --git a/poky/documentation/sdk-manual/sdk-appendix-customizing.rst b/poky/documentation/sdk-manual/sdk-appendix-customizing.rst
deleted file mode 100644
index 5a33f6385..000000000
--- a/poky/documentation/sdk-manual/sdk-appendix-customizing.rst
+++ /dev/null
@@ -1,377 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-******************************
-Customizing the Extensible SDK
-******************************
-
-This appendix describes customizations you can apply to the extensible
-SDK.
-
-Configuring the Extensible SDK
-==============================
-
-The extensible SDK primarily consists of a pre-configured copy of the
-OpenEmbedded build system from which it was produced. Thus, the SDK's
-configuration is derived using that build system and the filters shown
-in the following list. When these filters are present, the OpenEmbedded
-build system applies them against ``local.conf`` and ``auto.conf``:
-
-- Variables whose values start with "/" are excluded since the
- assumption is that those values are paths that are likely to be
- specific to the :term:`Build Host`.
-
-- Variables listed in
- :term:`SDK_LOCAL_CONF_BLACKLIST`
- are excluded. These variables are not allowed through from the
- OpenEmbedded build system configuration into the extensible SDK
- configuration. Typically, these variables are specific to the machine
- on which the build system is running and could be problematic as part
- of the extensible SDK configuration.
-
- For a list of the variables excluded by default, see the
- :term:`SDK_LOCAL_CONF_BLACKLIST`
- in the glossary of the Yocto Project Reference Manual.
-
-- Variables listed in
- :term:`SDK_LOCAL_CONF_WHITELIST`
- are included. Including a variable in the value of
- ``SDK_LOCAL_CONF_WHITELIST`` overrides either of the previous two
- filters. The default value is blank.
-
-- Classes inherited globally with
- :term:`INHERIT` that are listed in
- :term:`SDK_INHERIT_BLACKLIST`
- are disabled. Using ``SDK_INHERIT_BLACKLIST`` to disable these
- classes is the typical method to disable classes that are problematic
- or unnecessary in the SDK context. The default value blacklists the
- :ref:`buildhistory <ref-classes-buildhistory>`
- and :ref:`icecc <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,
-without any filtering. The ``sdk-extra.conf`` file is particularly
-useful if you want to set a variable value just for the SDK and not the
-OpenEmbedded build system used to create the SDK.
-
-Adjusting the Extensible SDK to Suit Your Build Host's Setup
-============================================================
-
-In most cases, the extensible SDK defaults should work with your :term:`Build
-Host`'s setup.
-However, some cases exist for which you might consider making
-adjustments:
-
-- If your SDK configuration inherits additional classes using the
- :term:`INHERIT` variable and you
- do not need or want those classes enabled in the SDK, you can
- blacklist them by adding them to the
- :term:`SDK_INHERIT_BLACKLIST`
- variable as described in the fourth bullet of the previous section.
-
- .. note::
-
- The default value of
- SDK_INHERIT_BLACKLIST
- 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 "
- Basic Syntax
- " section of the BitBake User Manual.
-
- .
-
-- If you have classes or recipes that add additional tasks to the
- standard build flow (i.e. the tasks execute as the recipe builds as
- opposed to being called explicitly), then you need to do one of the
- following:
-
- - After ensuring the tasks are :ref:`shared
- state <overview-manual/overview-manual-concepts:shared state cache>` tasks (i.e. the
- output of the task is saved to and can be restored from the shared
- state cache) or ensuring the tasks are able to be produced quickly
- from a task that is a shared state task, add the task name to the
- value of
- :term:`SDK_RECRDEP_TASKS`.
-
- - Disable the tasks if they are added by a class and you do not need
- the functionality the class provides in the extensible SDK. To
- disable the tasks, add the class to the ``SDK_INHERIT_BLACKLIST``
- variable as described in the previous section.
-
-- Generally, you want to have a shared state mirror set up so users of
- the SDK can add additional items to the SDK after installation
- without needing to build the items from source. See the "`Providing
- Additional Installable Extensible SDK
- Content <#sdk-providing-additional-installable-extensible-sdk-content>`__"
- section for information.
-
-- If you want users of the SDK to be able to easily update the SDK, you
- need to set the
- :term:`SDK_UPDATE_URL`
- variable. For more information, see the "`Providing Updates to the
- Extensible SDK After
- Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__"
- section.
-
-- If you have adjusted the list of files and directories that appear in
- :term:`COREBASE` (other than
- layers that are enabled through ``bblayers.conf``), then you must
- list these files in
- :term:`COREBASE_FILES` so
- that the files are copied into the SDK.
-
-- If your OpenEmbedded build system setup uses a different environment
- setup script other than
- :ref:`structure-core-script`, then you must
- set
- :term:`OE_INIT_ENV_SCRIPT`
- to point to the environment setup script you use.
-
- .. note::
-
- You must also reflect this change in the value used for the
- COREBASE_FILES
- variable as previously described.
-
-Changing the Extensible SDK Installer Title
-===========================================
-
-You can change the displayed title for the SDK installer by setting the
-:term:`SDK_TITLE` variable and then
-rebuilding the the SDK installer. For information on how to build an SDK
-installer, see the "`Building an SDK
-Installer <#sdk-building-an-sdk-installer>`__" section.
-
-By default, this title is derived from
-:term:`DISTRO_NAME` when it is
-set. If the ``DISTRO_NAME`` variable is not set, the title is derived
-from the :term:`DISTRO` variable.
-
-The
-:ref:`populate_sdk_base <ref-classes-populate-sdk-*>`
-class defines the default value of the ``SDK_TITLE`` variable as
-follows:
-::
-
- SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK"
-
-While several ways exist to change this variable, an efficient method is
-to set the variable in your distribution's configuration file. Doing so
-creates an SDK installer title that applies across your distribution. As
-an example, assume you have your own layer for your distribution named
-"meta-mydistro" and you are using the same type of file hierarchy as
-does the default "poky" distribution. If so, you could update the
-``SDK_TITLE`` variable in the
-``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following
-form:
-::
-
- SDK_TITLE = "your_title"
-
-Providing Updates to the Extensible SDK After Installation
-==========================================================
-
-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. 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
- to host the directory. This directory must contain the published SDK.
-
-2. 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,
- the user does not have to pass the URL to the ``devtool sdk-update``
- command as described in the "`Applying Updates to an Installed
- Extensible
- SDK <#sdk-applying-updates-to-an-installed-extensible-sdk>`__"
- section.
-
-3. Build the extensible SDK normally (i.e., use the
- ``bitbake -c populate_sdk_ext`` imagename command).
-
-4. Publish the SDK using the following command:
- ::
-
- $ 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 update mechanism.
-
-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 "`Applying Updates to an Installed Extensible
-SDK <#sdk-applying-updates-to-an-installed-extensible-sdk>`__" section
-for further information.
-
-Changing the Default SDK Installation Directory
-===============================================
-
-When you build the installer for the Extensible SDK, the default
-installation directory for the SDK is based on the
-:term:`DISTRO` and
-:term:`SDKEXTPATH` variables from
-within the
-:ref:`populate_sdk_base <ref-classes-populate-sdk-*>`
-class as follows:
-::
-
- SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk"
-
-You can
-change this default installation directory by specifically setting the
-``SDKEXTPATH`` variable.
-
-While a number of ways exist through which you can set this variable,
-the method that makes the most sense is to set the variable in your
-distribution's configuration file. Doing so creates an SDK installer
-default directory that applies across your distribution. As an example,
-assume you have your own layer for your distribution named
-"meta-mydistro" and you are using the same type of file hierarchy as
-does the default "poky" distribution. If so, you could update the
-``SDKEXTPATH`` variable in the
-``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following
-form:
-::
-
- SDKEXTPATH = "some_path_for_your_installed_sdk"
-
-After building your installer, running it prompts the user for
-acceptance of the some_path_for_your_installed_sdk directory as the
-default location to install the Extensible SDK.
-
-Providing Additional Installable Extensible SDK Content
-=======================================================
-
-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
- are already built:
-
- - Build the items explicitly. You could use one or more "meta"
- recipes that depend on lists of other recipes.
-
- - Build the "world" target and set
- ``EXCLUDE_FROM_WORLD_pn-``\ recipename for the recipes you do not
- want built. See the
- :term:`EXCLUDE_FROM_WORLD`
- variable for additional information.
-
-2. 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.
-
-3. 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`:
- ::
-
- SSTATE_MIRRORS = "file://.* http://example.com/some_path/sstate-cache/PATH"
-
- You can set the
- ``SSTATE_MIRRORS`` variable in two different places:
-
- - If the mirror value you are setting is appropriate to be set for
- both the OpenEmbedded build system that is actually building the
- SDK and the SDK itself (i.e. the mirror is accessible in both
- places or it will fail quickly on the OpenEmbedded build system
- side, and its contents will not interfere with the build), then
- you can set the variable in your ``local.conf`` or custom distro
- configuration file. You can then "whitelist" the variable through
- to the SDK by adding the following:
- ::
-
- SDK_LOCAL_CONF_WHITELIST = "SSTATE_MIRRORS"
-
- - Alternatively, if you just want to set the ``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
- layer and put your ``SSTATE_MIRRORS`` setting within that file.
-
- .. note::
-
- This second option is the safest option should you have any
- doubts as to which method to use when setting
- SSTATE_MIRRORS
- .
-
-Minimizing the Size of the Extensible SDK Installer Download
-============================================================
-
-By default, the extensible SDK bundles the shared state artifacts for
-everything needed to reconstruct the image for which the SDK was built.
-This bundling can lead to an SDK installer file that is a Gigabyte or
-more in size. If the size of this file causes a problem, you can build
-an SDK that has just enough in it to install and provide access to the
-``devtool command`` by setting the following in your configuration:
-::
-
- SDK_EXT_TYPE = "minimal"
-
-Setting
-:term:`SDK_EXT_TYPE` to
-"minimal" produces an SDK installer that is around 35 Mbytes in size,
-which downloads and installs quickly. You need to realize, though, that
-the minimal installer does not install any libraries or tools out of the
-box. These libraries and tools must be installed either "on the fly" or
-through actions you perform using ``devtool`` or explicitly with the
-``devtool sdk-install`` command.
-
-In most cases, when building a minimal SDK you need to also enable
-bringing in the information on a wider range of packages produced by the
-system. Requiring this wider range of information is particularly true
-so that ``devtool add`` is able to effectively map dependencies it
-discovers in a source tree to the appropriate recipes. Additionally, the
-information enables the ``devtool search`` command to return useful
-results.
-
-To facilitate this wider range of information, you would need to set the
-following:
-::
-
- SDK_INCLUDE_PKGDATA = "1"
-
-See the :term:`SDK_INCLUDE_PKGDATA` variable for additional information.
-
-Setting the ``SDK_INCLUDE_PKGDATA`` variable as shown causes the "world"
-target to be built so that information for all of the recipes included
-within it are available. Having these recipes available increases build
-time significantly and increases the size of the SDK installer by 30-80
-Mbytes depending on how many recipes are included in your configuration.
-
-You can use ``EXCLUDE_FROM_WORLD_pn-``\ recipename for recipes you want
-to exclude. However, it is assumed that you would need to be building
-the "world" target if you want to provide additional items to the SDK.
-Consequently, building for "world" should not represent undue overhead
-in most cases.
-
-.. note::
-
- If you set
- SDK_EXT_TYPE
- to "minimal", then providing a shared state mirror is mandatory so
- that items can be installed as needed. See the "
- Providing Additional Installable Extensible SDK Content
- " section for more information.
-
-You can explicitly control whether or not to include the toolchain when
-you build an SDK by setting the
-:term:`SDK_INCLUDE_TOOLCHAIN`
-variable to "1". In particular, it is useful to include the toolchain
-when you have set ``SDK_EXT_TYPE`` to "minimal", which by default,
-excludes the toolchain. Also, it is helpful if you are building a small
-SDK for use with an IDE or some other tool where you do not want to take
-extra steps to install a toolchain.