diff options
Diffstat (limited to 'documentation/ref-manual/varlocality.rst')
| -rw-r--r-- | documentation/ref-manual/varlocality.rst | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/documentation/ref-manual/varlocality.rst b/documentation/ref-manual/varlocality.rst new file mode 100644 index 0000000000..5f7dba8775 --- /dev/null +++ b/documentation/ref-manual/varlocality.rst | |||
| @@ -0,0 +1,166 @@ | |||
| 1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
| 2 | |||
| 3 | **************** | ||
| 4 | Variable Context | ||
| 5 | **************** | ||
| 6 | |||
| 7 | While you can use most variables in almost any context such as | ||
| 8 | ``.conf``, ``.bbclass``, ``.inc``, and ``.bb`` files, some variables are | ||
| 9 | often associated with a particular locality or context. This chapter | ||
| 10 | describes some common associations. | ||
| 11 | |||
| 12 | .. _ref-varlocality-configuration: | ||
| 13 | |||
| 14 | Configuration | ||
| 15 | ============= | ||
| 16 | |||
| 17 | The following subsections provide lists of variables whose context is | ||
| 18 | configuration: distribution, machine, and local. | ||
| 19 | |||
| 20 | .. _ref-varlocality-config-distro: | ||
| 21 | |||
| 22 | Distribution (Distro) | ||
| 23 | --------------------- | ||
| 24 | |||
| 25 | This section lists variables whose configuration context is the | ||
| 26 | distribution, or distro. | ||
| 27 | |||
| 28 | - :term:`DISTRO` | ||
| 29 | |||
| 30 | - :term:`DISTRO_NAME` | ||
| 31 | |||
| 32 | - :term:`DISTRO_VERSION` | ||
| 33 | |||
| 34 | - :term:`MAINTAINER` | ||
| 35 | |||
| 36 | - :term:`PACKAGE_CLASSES` | ||
| 37 | |||
| 38 | - :term:`TARGET_OS` | ||
| 39 | |||
| 40 | - :term:`TARGET_FPU` | ||
| 41 | |||
| 42 | - :term:`TCMODE` | ||
| 43 | |||
| 44 | - :term:`TCLIBC` | ||
| 45 | |||
| 46 | .. _ref-varlocality-config-machine: | ||
| 47 | |||
| 48 | Machine | ||
| 49 | ------- | ||
| 50 | |||
| 51 | This section lists variables whose configuration context is the machine. | ||
| 52 | |||
| 53 | - :term:`TARGET_ARCH` | ||
| 54 | |||
| 55 | - :term:`SERIAL_CONSOLES` | ||
| 56 | |||
| 57 | - :term:`PACKAGE_EXTRA_ARCHS` | ||
| 58 | |||
| 59 | - :term:`IMAGE_FSTYPES` | ||
| 60 | |||
| 61 | - :term:`MACHINE_FEATURES` | ||
| 62 | |||
| 63 | - :term:`MACHINE_EXTRA_RDEPENDS` | ||
| 64 | |||
| 65 | - :term:`MACHINE_EXTRA_RRECOMMENDS` | ||
| 66 | |||
| 67 | - :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS` | ||
| 68 | |||
| 69 | - :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` | ||
| 70 | |||
| 71 | .. _ref-varlocality-config-local: | ||
| 72 | |||
| 73 | Local | ||
| 74 | ----- | ||
| 75 | |||
| 76 | This section lists variables whose configuration context is the local | ||
| 77 | configuration through the ``local.conf`` file. | ||
| 78 | |||
| 79 | - :term:`DISTRO` | ||
| 80 | |||
| 81 | - :term:`MACHINE` | ||
| 82 | |||
| 83 | - :term:`DL_DIR` | ||
| 84 | |||
| 85 | - :term:`BBFILES` | ||
| 86 | |||
| 87 | - :term:`EXTRA_IMAGE_FEATURES` | ||
| 88 | |||
| 89 | - :term:`PACKAGE_CLASSES` | ||
| 90 | |||
| 91 | - :term:`BB_NUMBER_THREADS` | ||
| 92 | |||
| 93 | - :term:`BBINCLUDELOGS` | ||
| 94 | |||
| 95 | - :term:`ENABLE_BINARY_LOCALE_GENERATION` | ||
| 96 | |||
| 97 | .. _ref-varlocality-recipes: | ||
| 98 | |||
| 99 | Recipes | ||
| 100 | ======= | ||
| 101 | |||
| 102 | The following subsections provide lists of variables whose context is | ||
| 103 | recipes: required, dependencies, path, and extra build information. | ||
| 104 | |||
| 105 | .. _ref-varlocality-recipe-required: | ||
| 106 | |||
| 107 | Required | ||
| 108 | -------- | ||
| 109 | |||
| 110 | This section lists variables that are required for recipes. | ||
| 111 | |||
| 112 | - :term:`LICENSE` | ||
| 113 | |||
| 114 | - :term:`LIC_FILES_CHKSUM` | ||
| 115 | |||
| 116 | - :term:`SRC_URI` - used in recipes that fetch local or remote files. | ||
| 117 | |||
| 118 | .. _ref-varlocality-recipe-dependencies: | ||
| 119 | |||
| 120 | Dependencies | ||
| 121 | ------------ | ||
| 122 | |||
| 123 | This section lists variables that define recipe dependencies. | ||
| 124 | |||
| 125 | - :term:`DEPENDS` | ||
| 126 | |||
| 127 | - :term:`RDEPENDS` | ||
| 128 | |||
| 129 | - :term:`RRECOMMENDS` | ||
| 130 | |||
| 131 | - :term:`RCONFLICTS` | ||
| 132 | |||
| 133 | - :term:`RREPLACES` | ||
| 134 | |||
| 135 | .. _ref-varlocality-recipe-paths: | ||
| 136 | |||
| 137 | Paths | ||
| 138 | ----- | ||
| 139 | |||
| 140 | This section lists variables that define recipe paths. | ||
| 141 | |||
| 142 | - :term:`WORKDIR` | ||
| 143 | |||
| 144 | - :term:`S` | ||
| 145 | |||
| 146 | - :term:`FILES` | ||
| 147 | |||
| 148 | .. _ref-varlocality-recipe-build: | ||
| 149 | |||
| 150 | Extra Build Information | ||
| 151 | ----------------------- | ||
| 152 | |||
| 153 | This section lists variables that define extra build information for | ||
| 154 | recipes. | ||
| 155 | |||
| 156 | - :term:`DEFAULT_PREFERENCE` | ||
| 157 | |||
| 158 | - :term:`EXTRA_OECMAKE` | ||
| 159 | |||
| 160 | - :term:`EXTRA_OECONF` | ||
| 161 | |||
| 162 | - :term:`EXTRA_OEMAKE` | ||
| 163 | |||
| 164 | - :term:`PACKAGECONFIG_CONFARGS` | ||
| 165 | |||
| 166 | - :term:`PACKAGES` | ||
