summaryrefslogtreecommitdiff
path: root/poky/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
authorAndrew Geissler <geissonator@yahoo.com>2021-04-15 23:55:55 +0300
committerBrad Bishop <bradleyb@fuzziesquirrel.com>2021-04-19 16:32:18 +0300
commit3b8a17c1d70bac29dd3f1fb727716b7c2151b64a (patch)
treecc03ed84987f273db964a019f862b08a131d67fa /poky/documentation/ref-manual/variables.rst
parente34f89623c246d261efb7fd0f2ce4a30b10bd59d (diff)
downloadopenbmc-3b8a17c1d70bac29dd3f1fb727716b7c2151b64a.tar.xz
poky: subtree update:7d0988966c..1203d1f24d
Alexander Kanavin (5): mesa: update 21.0.0 -> 21.0.1 runqemu: do not stop processing graphical options after nographic mesa: gallium option requires libdrm mesa: enable dri in native/nativesdk through gallium drivers ptest-runner: correct version check Alistair Francis (2): conf/machine: Enable bochs-display on RISC-V machines conf/machine: Enable keyboard and mouse on RISC-V machines Anibal Limon (1): ptest-runner: Upgrade to 2.4.1 Awais Belal (2): perl: allow empty lines and comments in perl-rdepends.txt perl: fix creation and generate new perl-rdepends.txt Bruce Ashfield (1): perf-tests: add bash into RDEPENDS (v5.12-rc5+) Chen Qi (1): apt: Fix do_compile error when enable ccache Denys Dmytriyenko (1): make-mod-scripts: pass CROSS_COMPILE to configure and build Guillaume Champagne (1): image-live.bbclass: optional depends when ROOTFS empty Janne Kiiskila (1): poky.yaml: Use git instead of git-core for Ubunti Joshua Watt (1): bitbake.conf: Limit the number of OpenMP threads Khem Raj (3): mesa-gl: Use swrast gallium driver binutils: Fix a missing break in case statement webkitgtk: Drop include_array.patch Klaus Heinrich Kiwi (6): uboot: Deploy default symlinks with fitImage u-boot: Move definitions to common locations u-boot: Add infrastructure to SPL verified boot u-boot: Use a different Key for SPL signing oe-selftest: Add U-Boot fitImage signing testcases uboot: Fixes SPL verified boot on corner cases Matt Madison (1): libxcb: use PN for naming dynamic packages Michael Halstead (1): releases: update to include 3.2.3 Michael Opdenacker (7): manuals: Spellcheck and capitalization fixes SDK manual: fix reference to appendix Quick build: checkout a branch instead of a fixed tag manuals: Fix typos and spacing overview-manual: style improvements ref-manual: fix typo manuals: fix suspicious newlines Nicolas Dechesne (1): docs: add a top level page for bitbake documentation Paul Eggleton (16): bitbake: bitbake-user-manual: document no support for using passwords in git URLs bitbake: bitbake-user-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry ref-manual: add METADATA_REVISION and METADATA_BRANCH Use variables for minimum host versions and bump Python to 3.6 ref-manual: update/fix text for SDK_VERSION overview-manual: fix git command line ref-manual: and SDK_CUSTOM_TEMPLATECONF to glossary ref-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry ref-manual: add python3targetconfig class and remove python 2 references ref-manual: add passwd-expire to EXTRA_USERS_PARAMS ref-manual: add FIT_KERNEL_COMP_ALG* ref-manual: fix reference to build-essential ref-manual: tweak buildtools section ref-manual: add migration section for 3.3 release ref-manual: migration guide: add release codenames ref-manual: add mention of DISTUTILS_SETUP_PATH Quentin Schulz (1): docs: replace anchor links Richard Purdie (9): oeqa/concurrencytest: Rename variables to improve the code oeqa/concurrencytest: Fix display of test stdout/stderr diffoscope: Upgrade 168 -> 172 oeqa/runqemu: Support RUNQEMU_TMPFS_DIR as a location to copy snapshot images to bitbake: runqueue: Further fixes for confused setscene tasks documentation/poky.yaml: Fix latest 3.2 series tag reference poky.conf: Bump version for 3.3 hardknott release build-appliance-image: Update to master head revision bitbake: bitbake: Update version to 1.50.0 stable release series Ross Burton (2): poky.yaml: change gcc-multilib to gcc oeqa/selftest: add test case for SRC_URI dependency sniffing Ulrich Ölmann (1): sdk-manual: fix typo Yann Dirson (1): kernel-yocto: fix do_kernel_configme indentation Yi Fan Yu (2): python3: Skip failing ptests due to load variability valgrind: print failed ptest details Signed-off-by: Andrew Geissler <geissonator@yahoo.com> Change-Id: Id57d0682ec91b67b90fac931313457f5ed6f3d5c
Diffstat (limited to 'poky/documentation/ref-manual/variables.rst')
-rw-r--r--poky/documentation/ref-manual/variables.rst107
1 files changed, 82 insertions, 25 deletions
diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst
index 0310429bd..74ac12bf9 100644
--- a/poky/documentation/ref-manual/variables.rst
+++ b/poky/documentation/ref-manual/variables.rst
@@ -768,9 +768,7 @@ system and gives an overview of their function and contents.
.. note::
If you run BitBake from a directory outside of the
- Build Directory
- , you must be sure to set
- BBPATH
+ :term:`Build Directory`, you must be sure to set ``BBPATH``
to point to the Build Directory. Set the variable as you would any
environment variable and then run BitBake:
::
@@ -1980,6 +1978,19 @@ system and gives an overview of their function and contents.
is included in the default value of
:term:`OVERRIDES`.
+ :term:`DISTUTILS_SETUP_PATH`
+ When used by recipes that inherit the
+ :ref:`distutils3 <ref-classes-distutils3>` or
+ :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable should
+ be used to specify the directory in which the ``setup.py`` file is
+ located if it is not at the root of the source tree (as specified by
+ :term:`S`). For example, in a recipe where the sources are fetched from
+ a Git repository and ``setup.py`` is in a ``python/pythonmodule``
+ subdirectory, you would have this::
+
+ S = "${WORKDIR}/git"
+ DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule"
+
:term:`DL_DIR`
The central download directory used by the build process to store
downloads. By default, ``DL_DIR`` gets files suitable for mirroring
@@ -2295,6 +2306,17 @@ system and gives an overview of their function and contents.
# usermod -s /bin/sh tester; \
# "
+ Additionally there is a special ``passwd-expire`` command that will
+ cause the password for a user to be expired and thus force changing it
+ on first login, for example::
+
+ EXTRA_USERS_PARAMS += " useradd myuser; passwd-expire myuser;"
+
+ .. note::
+
+ At present, ``passwd-expire`` may only work for remote logins when
+ using OpenSSH and not dropbear as an SSH server.
+
:term:`FEATURE_PACKAGES`
Defines one or more packages to include in an image when a specific
item is included in :term:`IMAGE_FEATURES`.
@@ -2571,6 +2593,16 @@ system and gives an overview of their function and contents.
:term:`FIT_HASH_ALG`
Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256.
+ :term:`FIT_KERNEL_COMP_ALG`
+ Compression algorithm to use for the kernel image inside the FIT Image.
+ At present, the only supported values are "gzip" (default) or "none"
+ If you set this variable to anything other than "none" you may also need
+ to set :term:`FIT_KERNEL_COMP_ALG_EXTENSION`.
+
+ :term:`FIT_KERNEL_COMP_ALG_EXTENSION`
+ File extension corresponding to :term:`FIT_KERNEL_COMP_ALG`. The default
+ value is ".gz".
+
:term:`FIT_KEY_GENRSA_ARGS`
Arguments to openssl genrsa for generating RSA private key for signing
fitImage. The default value is "-F4". i.e. the public exponent 65537 to
@@ -2582,7 +2614,7 @@ system and gives an overview of their function and contents.
and new for generating new keys.
:term:`FIT_KEY_SIGN_PKCS`
- Format for public key ceritifcate used in signing fitImage.
+ Format for public key certificate used in signing fitImage.
The default value is "x509".
:term:`FIT_SIGN_ALG`
@@ -2991,7 +3023,7 @@ system and gives an overview of their function and contents.
:term:`IMAGE_CMD`
Specifies the command to create the image file for a specific image
- type, which corresponds to the value set set in
+ type, which corresponds to the value set in
:term:`IMAGE_FSTYPES`, (e.g. ``ext3``,
``btrfs``, and so forth). When setting this variable, you should use
an override for the associated type. Here is an example:
@@ -3449,7 +3481,7 @@ system and gives an overview of their function and contents.
It is possible to define a list of licenses that are allowed to be
used instead of the licenses that are excluded. To do this, define
- a variable ``COMPATIBLE_LICENSES`` with the names of the licences
+ a variable ``COMPATIBLE_LICENSES`` with the names of the licenses
that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as:
::
@@ -3457,8 +3489,8 @@ system and gives an overview of their function and contents.
This will result in ``INCOMPATIBLE_LICENSE`` containing the names of
- all licences from :term:`AVAILABLE_LICENSES` except the ones specified
- in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licences to
+ all licenses from :term:`AVAILABLE_LICENSES` except the ones specified
+ in ``COMPATIBLE_LICENSES``, thus only allowing the latter licenses to
be used.
:term:`INHERIT`
@@ -4661,6 +4693,14 @@ system and gives an overview of their function and contents.
:term:`MAINTAINER`
The email address of the distribution maintainer.
+ :term:`METADATA_BRANCH`
+ The branch currently checked out for the OpenEmbedded-Core layer (path
+ determined by :term:`COREBASE`).
+
+ :term:`METADATA_REVISION`
+ The revision currently checked out for the OpenEmbedded-Core layer (path
+ determined by :term:`COREBASE`).
+
:term:`MIRRORS`
Specifies additional paths from which the OpenEmbedded build system
gets source code. When the build system searches for source code, it
@@ -5011,7 +5051,7 @@ system and gives an overview of their function and contents.
${PN}-${PV}
:term:`PACKAGE_ADD_METADATA`
- This variable defines additional metdata to add to packages.
+ This variable defines additional metadata to add to packages.
You may find you need to inject additional metadata into packages.
This variable allows you to do that by setting the injected data as
@@ -5792,10 +5832,11 @@ system and gives an overview of their function and contents.
exclusive alternative providers.
:term:`PREFERRED_VERSION`
- If multiple versions of recipes exist, this variable determines which
- version is given preference. You must always suffix the variable with
- the :term:`PN` you want to select, and you should set the
- :term:`PV` accordingly for precedence.
+ If there are multiple versions of a recipe available, this variable
+ determines which version should be given preference. You must always
+ suffix the variable with the :term:`PN` you want to select (`python` in
+ the first example below), and you should specify the :term:`PV`
+ accordingly (`3.4.0` in the example).
The ``PREFERRED_VERSION`` variable supports limited wildcard use
through the "``%``" character. You can use the character to match any
@@ -5853,6 +5894,10 @@ system and gives an overview of their function and contents.
The ``\_forcevariable`` override is not handled specially. This override
only works because the default value of ``OVERRIDES`` includes "forcevariable".
+ If a recipe with the specified version is not available, a warning
+ message will be shown. See :term:`REQUIRED_VERSION` if you want this
+ to be an error instead.
+
:term:`PREMIRRORS`
Specifies additional paths from which the OpenEmbedded build system
gets source code. When the build system searches for source code, it
@@ -6019,9 +6064,7 @@ system and gives an overview of their function and contents.
:term:`PYTHON_ABI`
When used by recipes that inherit the
:ref:`distutils3 <ref-classes-distutils3>`,
- :ref:`setuptools3 <ref-classes-setuptools3>`,
- :ref:`distutils <ref-classes-distutils>`, or
- :ref:`setuptools <ref-classes-setuptools>` classes, denotes the
+ :ref:`setuptools3 <ref-classes-setuptools3>` classes, denotes the
Application Binary Interface (ABI) currently in use for Python. By
default, the ABI is "m". You do not have to set this variable as the
OpenEmbedded build system sets it for you.
@@ -6030,16 +6073,14 @@ system and gives an overview of their function and contents.
names used when installing the Python headers and libraries in
sysroot (e.g. ``.../python3.3m/...``).
- Recipes that inherit the ``distutils`` class during cross-builds also
+ Recipes that inherit the ``distutils3`` class during cross-builds also
use this variable to locate the headers and libraries of the
appropriate Python that the extension is targeting.
:term:`PYTHON_PN`
When used by recipes that inherit the
`distutils3 <ref-classes-distutils3>`,
- :ref:`setuptools3 <ref-classes-setuptools3>`,
- :ref:`distutils <ref-classes-distutils>`, or
- :ref:`setuptools <ref-classes-setuptools>` classes, specifies the
+ :ref:`setuptools3 <ref-classes-setuptools3>` classes, specifies the
major Python version being built. For Python 3.x, ``PYTHON_PN`` would
be "python3". You do not have to set this variable as the
OpenEmbedded build system automatically sets it for you.
@@ -6210,6 +6251,17 @@ system and gives an overview of their function and contents.
the recipe will be skipped, and if the build system attempts to build
the recipe then an error will be triggered.
+ :term:`REQUIRED_VERSION`
+ If there are multiple versions of a recipe available, this variable
+ determines which version should be given preference.
+ :term:`REQUIRED_VERSION` works in exactly the same manner as
+ :term:`PREFERRED_VERSION`, except that if the specified version is not
+ available then an error message is shown and the build fails
+ immediately.
+
+ If both :term:`REQUIRED_VERSION` and :term:`PREFERRED_VERSION` are set
+ for the same recipe, the :term:`REQUIRED_VERSION` value applies.
+
:term:`RM_WORK_EXCLUDE`
With ``rm_work`` enabled, this variable specifies a list of recipes
whose work directories should not be removed. See the
@@ -6483,6 +6535,11 @@ system and gives an overview of their function and contents.
The target architecture for the SDK. Typically, you do not directly
set this variable. Instead, use :term:`SDKMACHINE`.
+ :term:`SDK_CUSTOM_TEMPLATECONF`
+ When building the extensible SDK, if ``SDK_CUSTOM_TEMPLATECONF`` is set to
+ "1" and a ``conf/templateconf.conf`` file exists in the build directory
+ (:term:`TOPDIR`) then this will be copied into the SDK.
+
:term:`SDK_DEPLOY`
The directory set up and used by the
:ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which
@@ -6758,16 +6815,16 @@ system and gives an overview of their function and contents.
Specifies the name of the SDK vendor.
:term:`SDK_VERSION`
- Specifies the version of the SDK. The distribution configuration file
- (e.g. ``/meta-poky/conf/distro/poky.conf``) defines the
+ Specifies the version of the SDK. The Poky distribution configuration file
+ (``/meta-poky/conf/distro/poky.conf``) sets the default
``SDK_VERSION`` as follows:
::
- SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${DATE}','snapshot')}"
+ SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${METADATA_REVISION}', 'snapshot')}"
For additional information, see the
:term:`DISTRO_VERSION` and
- :term:`DATE` variables.
+ :term:`METADATA_REVISION` variables.
:term:`SDKEXTPATH`
The default installation directory for the Extensible SDK. By
@@ -7092,7 +7149,7 @@ system and gives an overview of their function and contents.
- ``git://`` - Fetches files from a Git revision control
repository.
- - ``osc://`` - Fetches files from an OSC (OpenSUSE Build service)
+ - ``osc://`` - Fetches files from an OSC (openSUSE Build service)
revision control repository.
- ``repo://`` - Fetches files from a repo (Git) repository.