poky/documentation/ref-manual/varlocality.rst
Michael Opdenacker 5b75b5cbcf manuals: replace hyphens with em dashes
Fix some hyphens being improperly used as em dashes.
See https://www.grammarly.com/blog/hyphens-and-dashes/

Using em dashes may also allow Sphinx to hyphenate
and break lines in the best way.

Note that the first character after an em dash not
supposed to be capitalized, unless a specific
rule applies, typically when what follows is a proper noun.

Fix a few misuses of parentheses in following text.

(From yocto-docs rev: a0d93ea1ddfdfbcde8dac3aa328307be778f9e3c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-25 04:11:26 -10:00

167 lines
2.8 KiB
ReStructuredText

.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
****************
Variable Context
****************
While you can use most variables in almost any context such as
``.conf``, ``.bbclass``, ``.inc``, and ``.bb`` files, some variables are
often associated with a particular locality or context. This chapter
describes some common associations.
.. _ref-varlocality-configuration:
Configuration
=============
The following subsections provide lists of variables whose context is
configuration: distribution, machine, and local.
.. _ref-varlocality-config-distro:
Distribution (Distro)
---------------------
This section lists variables whose configuration context is the
distribution, or distro.
- :term:`DISTRO`
- :term:`DISTRO_NAME`
- :term:`DISTRO_VERSION`
- :term:`MAINTAINER`
- :term:`PACKAGE_CLASSES`
- :term:`TARGET_OS`
- :term:`TARGET_FPU`
- :term:`TCMODE`
- :term:`TCLIBC`
.. _ref-varlocality-config-machine:
Machine
-------
This section lists variables whose configuration context is the machine.
- :term:`TARGET_ARCH`
- :term:`SERIAL_CONSOLES`
- :term:`PACKAGE_EXTRA_ARCHS`
- :term:`IMAGE_FSTYPES`
- :term:`MACHINE_FEATURES`
- :term:`MACHINE_EXTRA_RDEPENDS`
- :term:`MACHINE_EXTRA_RRECOMMENDS`
- :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
- :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
.. _ref-varlocality-config-local:
Local
-----
This section lists variables whose configuration context is the local
configuration through the ``local.conf`` file.
- :term:`DISTRO`
- :term:`MACHINE`
- :term:`DL_DIR`
- :term:`BBFILES`
- :term:`EXTRA_IMAGE_FEATURES`
- :term:`PACKAGE_CLASSES`
- :term:`BB_NUMBER_THREADS`
- :term:`BBINCLUDELOGS`
- :term:`ENABLE_BINARY_LOCALE_GENERATION`
.. _ref-varlocality-recipes:
Recipes
=======
The following subsections provide lists of variables whose context is
recipes: required, dependencies, path, and extra build information.
.. _ref-varlocality-recipe-required:
Required
--------
This section lists variables that are required for recipes.
- :term:`LICENSE`
- :term:`LIC_FILES_CHKSUM`
- :term:`SRC_URI` --- used in recipes that fetch local or remote files.
.. _ref-varlocality-recipe-dependencies:
Dependencies
------------
This section lists variables that define recipe dependencies.
- :term:`DEPENDS`
- :term:`RDEPENDS`
- :term:`RRECOMMENDS`
- :term:`RCONFLICTS`
- :term:`RREPLACES`
.. _ref-varlocality-recipe-paths:
Paths
-----
This section lists variables that define recipe paths.
- :term:`WORKDIR`
- :term:`S`
- :term:`FILES`
.. _ref-varlocality-recipe-build:
Extra Build Information
-----------------------
This section lists variables that define extra build information for
recipes.
- :term:`DEFAULT_PREFERENCE`
- :term:`EXTRA_OECMAKE`
- :term:`EXTRA_OECONF`
- :term:`EXTRA_OEMAKE`
- :term:`PACKAGECONFIG_CONFARGS`
- :term:`PACKAGES`