diff options
Diffstat (limited to 'bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst')
-rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 74 |
1 files changed, 37 insertions, 37 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst index 790065ef64..cea8d5ba25 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | |||
@@ -397,7 +397,7 @@ Among the variables commonly exported to the environment are ``CC`` and | |||
397 | Conditional Syntax (Overrides) | 397 | Conditional Syntax (Overrides) |
398 | ============================== | 398 | ============================== |
399 | 399 | ||
400 | BitBake uses ```OVERRIDES`` <#var-bb-OVERRIDES>`__ to control what | 400 | BitBake uses :term:`OVERRIDES` to control what |
401 | variables are overridden after BitBake parses recipes and configuration | 401 | variables are overridden after BitBake parses recipes and configuration |
402 | files. This section describes how you can use ``OVERRIDES`` as | 402 | files. This section describes how you can use ``OVERRIDES`` as |
403 | conditional metadata, talks about key expansion in relationship to | 403 | conditional metadata, talks about key expansion in relationship to |
@@ -463,7 +463,7 @@ variable. | |||
463 | 463 | ||
464 | Internally, this is implemented by prepending the task (e.g. | 464 | Internally, this is implemented by prepending the task (e.g. |
465 | "task-compile:") to the value of | 465 | "task-compile:") to the value of |
466 | ```OVERRIDES`` <#var-bb-OVERRIDES>`__ for the local datastore of the | 466 | :term:`OVERRIDES` for the local datastore of the |
467 | ``do_compile`` task. | 467 | ``do_compile`` task. |
468 | 468 | ||
469 | You can also use this syntax with other combinations (e.g. | 469 | You can also use this syntax with other combinations (e.g. |
@@ -549,7 +549,7 @@ directives. | |||
549 | Locating Include and Class Files | 549 | Locating Include and Class Files |
550 | -------------------------------- | 550 | -------------------------------- |
551 | 551 | ||
552 | BitBake uses the ```BBPATH`` <#var-bb-BBPATH>`__ variable to locate | 552 | BitBake uses the :term:`BBPATH` variable to locate |
553 | needed include and class files. Additionally, BitBake searches the | 553 | needed include and class files. Additionally, BitBake searches the |
554 | current directory for ``include`` and ``require`` directives. | 554 | current directory for ``include`` and ``require`` directives. |
555 | 555 | ||
@@ -680,7 +680,7 @@ directive from within each recipe: require foo.inc | |||
680 | ----------------------------------- | 680 | ----------------------------------- |
681 | 681 | ||
682 | When creating a configuration file (``.conf``), you can use the | 682 | When creating a configuration file (``.conf``), you can use the |
683 | ```INHERIT`` <#var-bb-INHERIT>`__ configuration directive to inherit a | 683 | :term:`INHERIT` configuration directive to inherit a |
684 | class. BitBake only supports this directive when used within a | 684 | class. BitBake only supports this directive when used within a |
685 | configuration file. | 685 | configuration file. |
686 | 686 | ||
@@ -837,7 +837,7 @@ functions and regular Python functions defined with "def": | |||
837 | Python functions, but not on regular Python functions. | 837 | Python functions, but not on regular Python functions. |
838 | 838 | ||
839 | - BitBake-style Python functions generate a separate | 839 | - BitBake-style Python functions generate a separate |
840 | ``${``\ ```T`` <#var-bb-T>`__\ ``}/run.``\ function-name\ ``.``\ pid | 840 | ``${``\ :term:`T`\ ``}/run.``\ function-name\ ``.``\ pid |
841 | script that is executed to run the function, and also generate a log | 841 | script that is executed to run the function, and also generate a log |
842 | file in ``${T}/log.``\ function-name\ ``.``\ pid if they are executed | 842 | file in ``${T}/log.``\ function-name\ ``.``\ pid if they are executed |
843 | as tasks. | 843 | as tasks. |
@@ -1090,8 +1090,8 @@ environment, you must take these two steps: | |||
1090 | 1090 | ||
1091 | 1. Tell BitBake to load what you want from the environment into the | 1091 | 1. Tell BitBake to load what you want from the environment into the |
1092 | datastore. You can do so through the | 1092 | datastore. You can do so through the |
1093 | ```BB_ENV_WHITELIST`` <#var-bb-BB_ENV_WHITELIST>`__ and | 1093 | :term:`BB_ENV_WHITELIST` and |
1094 | ```BB_ENV_EXTRAWHITE`` <#var-bb-BB_ENV_EXTRAWHITE>`__ variables. For | 1094 | :term:`BB_ENV_EXTRAWHITE` variables. For |
1095 | example, assume you want to prevent the build system from accessing | 1095 | example, assume you want to prevent the build system from accessing |
1096 | your ``$HOME/.ccache`` directory. The following command "whitelists" | 1096 | your ``$HOME/.ccache`` directory. The following command "whitelists" |
1097 | the environment variable ``CCACHE_DIR`` causing BitBake to allow that | 1097 | the environment variable ``CCACHE_DIR`` causing BitBake to allow that |
@@ -1117,7 +1117,7 @@ environment, you must take these two steps: | |||
1117 | Sometimes, it is useful to be able to obtain information from the | 1117 | Sometimes, it is useful to be able to obtain information from the |
1118 | original execution environment. BitBake saves a copy of the original | 1118 | original execution environment. BitBake saves a copy of the original |
1119 | environment into a special variable named | 1119 | environment into a special variable named |
1120 | ```BB_ORIGENV`` <#var-bb-BB_ORIGENV>`__. | 1120 | :term:`BB_ORIGENV`. |
1121 | 1121 | ||
1122 | The ``BB_ORIGENV`` variable returns a datastore object that can be | 1122 | The ``BB_ORIGENV`` variable returns a datastore object that can be |
1123 | queried using the standard datastore operators such as | 1123 | queried using the standard datastore operators such as |
@@ -1149,12 +1149,12 @@ functionality of the task: | |||
1149 | recreated to empty them. | 1149 | recreated to empty them. |
1150 | 1150 | ||
1151 | - *``[depends]``:* Controls inter-task dependencies. See the | 1151 | - *``[depends]``:* Controls inter-task dependencies. See the |
1152 | ```DEPENDS`` <#var-bb-DEPENDS>`__ variable and the "`Inter-Task | 1152 | :term:`DEPENDS` variable and the "`Inter-Task |
1153 | Dependencies <#inter-task-dependencies>`__" section for more | 1153 | Dependencies <#inter-task-dependencies>`__" section for more |
1154 | information. | 1154 | information. |
1155 | 1155 | ||
1156 | - *``[deptask]``:* Controls task build-time dependencies. See the | 1156 | - *``[deptask]``:* Controls task build-time dependencies. See the |
1157 | ```DEPENDS`` <#var-bb-DEPENDS>`__ variable and the "`Build | 1157 | :term:`DEPENDS` variable and the "`Build |
1158 | Dependencies <#build-dependencies>`__" section for more information. | 1158 | Dependencies <#build-dependencies>`__" section for more information. |
1159 | 1159 | ||
1160 | - *``[dirs]``:* Directories that should be created before the task | 1160 | - *``[dirs]``:* Directories that should be created before the task |
@@ -1189,7 +1189,7 @@ functionality of the task: | |||
1189 | your build host has a large number of cores but certain tasks need to | 1189 | your build host has a large number of cores but certain tasks need to |
1190 | be rate-limited due to various kinds of resource constraints (e.g. to | 1190 | be rate-limited due to various kinds of resource constraints (e.g. to |
1191 | avoid network throttling). ``number_threads`` works similarly to the | 1191 | avoid network throttling). ``number_threads`` works similarly to the |
1192 | ```BB_NUMBER_THREADS`` <#var-bb-BB_NUMBER_THREADS>`__ variable but is | 1192 | :term:`BB_NUMBER_THREADS` variable but is |
1193 | task-specific. | 1193 | task-specific. |
1194 | 1194 | ||
1195 | Set the value globally. For example, the following makes sure the | 1195 | Set the value globally. For example, the following makes sure the |
@@ -1211,14 +1211,14 @@ functionality of the task: | |||
1211 | - *``[prefuncs]``:* List of functions to call before the task executes. | 1211 | - *``[prefuncs]``:* List of functions to call before the task executes. |
1212 | 1212 | ||
1213 | - *``[rdepends]``:* Controls inter-task runtime dependencies. See the | 1213 | - *``[rdepends]``:* Controls inter-task runtime dependencies. See the |
1214 | ```RDEPENDS`` <#var-bb-RDEPENDS>`__ variable, the | 1214 | :term:`RDEPENDS` variable, the |
1215 | ```RRECOMMENDS`` <#var-bb-RRECOMMENDS>`__ variable, and the | 1215 | :term:`RRECOMMENDS` variable, and the |
1216 | "`Inter-Task Dependencies <#inter-task-dependencies>`__" section for | 1216 | "`Inter-Task Dependencies <#inter-task-dependencies>`__" section for |
1217 | more information. | 1217 | more information. |
1218 | 1218 | ||
1219 | - *``[rdeptask]``:* Controls task runtime dependencies. See the | 1219 | - *``[rdeptask]``:* Controls task runtime dependencies. See the |
1220 | ```RDEPENDS`` <#var-bb-RDEPENDS>`__ variable, the | 1220 | :term:`RDEPENDS` variable, the |
1221 | ```RRECOMMENDS`` <#var-bb-RRECOMMENDS>`__ variable, and the "`Runtime | 1221 | :term:`RRECOMMENDS` variable, and the "`Runtime |
1222 | Dependencies <#runtime-dependencies>`__" section for more | 1222 | Dependencies <#runtime-dependencies>`__" section for more |
1223 | information. | 1223 | information. |
1224 | 1224 | ||
@@ -1227,8 +1227,8 @@ functionality of the task: | |||
1227 | dependencies. | 1227 | dependencies. |
1228 | 1228 | ||
1229 | - *``[recrdeptask]``:* Controls task recursive runtime dependencies. | 1229 | - *``[recrdeptask]``:* Controls task recursive runtime dependencies. |
1230 | See the ```RDEPENDS`` <#var-bb-RDEPENDS>`__ variable, the | 1230 | See the :term:`RDEPENDS` variable, the |
1231 | ```RRECOMMENDS`` <#var-bb-RRECOMMENDS>`__ variable, and the | 1231 | :term:`RRECOMMENDS` variable, and the |
1232 | "`Recursive Dependencies <#recursive-dependencies>`__" section for | 1232 | "`Recursive Dependencies <#recursive-dependencies>`__" section for |
1233 | more information. | 1233 | more information. |
1234 | 1234 | ||
@@ -1390,8 +1390,8 @@ Variants - Class Extension Mechanism | |||
1390 | BitBake supports two features that facilitate creating from a single | 1390 | BitBake supports two features that facilitate creating from a single |
1391 | recipe file multiple incarnations of that recipe file where all | 1391 | recipe file multiple incarnations of that recipe file where all |
1392 | incarnations are buildable. These features are enabled through the | 1392 | incarnations are buildable. These features are enabled through the |
1393 | ```BBCLASSEXTEND`` <#var-bb-BBCLASSEXTEND>`__ and | 1393 | :term:`BBCLASSEXTEND` and |
1394 | ```BBVERSIONS`` <#var-bb-BBVERSIONS>`__ variables. | 1394 | :term:`BBVERSIONS` variables. |
1395 | 1395 | ||
1396 | .. note:: | 1396 | .. note:: |
1397 | 1397 | ||
@@ -1420,7 +1420,7 @@ incarnations are buildable. These features are enabled through the | |||
1420 | - *``BBVERSIONS``:* This variable allows a single recipe to build | 1420 | - *``BBVERSIONS``:* This variable allows a single recipe to build |
1421 | multiple versions of a project from a single recipe file. You can | 1421 | multiple versions of a project from a single recipe file. You can |
1422 | also specify conditional metadata (using the | 1422 | also specify conditional metadata (using the |
1423 | ```OVERRIDES`` <#var-bb-OVERRIDES>`__ mechanism) for a single | 1423 | :term:`OVERRIDES` mechanism) for a single |
1424 | version, or an optionally named range of versions. Here is an | 1424 | version, or an optionally named range of versions. Here is an |
1425 | example: BBVERSIONS = "1.0 2.0 git" SRC_URI_git = | 1425 | example: BBVERSIONS = "1.0 2.0 git" SRC_URI_git = |
1426 | "git://someurl/somepath.git" BBVERSIONS = "1.0.[0-6]:1.0.0+ \\ | 1426 | "git://someurl/somepath.git" BBVERSIONS = "1.0.[0-6]:1.0.0+ \\ |
@@ -1432,7 +1432,7 @@ incarnations are buildable. These features are enabled through the | |||
1432 | name is not only placed into overrides, but it is also made available | 1432 | name is not only placed into overrides, but it is also made available |
1433 | for the metadata to use in the variable that defines the base recipe | 1433 | for the metadata to use in the variable that defines the base recipe |
1434 | versions for use in ``file://`` search paths | 1434 | versions for use in ``file://`` search paths |
1435 | (```FILESPATH`` <#var-bb-FILESPATH>`__). | 1435 | (:term:`FILESPATH`). |
1436 | 1436 | ||
1437 | Dependencies | 1437 | Dependencies |
1438 | ============ | 1438 | ============ |
@@ -1491,7 +1491,7 @@ task depends on the completion of the ``do_printdate`` task. | |||
1491 | Build Dependencies | 1491 | Build Dependencies |
1492 | ------------------ | 1492 | ------------------ |
1493 | 1493 | ||
1494 | BitBake uses the ```DEPENDS`` <#var-bb-DEPENDS>`__ variable to manage | 1494 | BitBake uses the :term:`DEPENDS` variable to manage |
1495 | build time dependencies. The ``[deptask]`` varflag for tasks signifies | 1495 | build time dependencies. The ``[deptask]`` varflag for tasks signifies |
1496 | the task of each item listed in ``DEPENDS`` that must complete before | 1496 | the task of each item listed in ``DEPENDS`` that must complete before |
1497 | that task can be executed. Here is an example: do_configure[deptask] = | 1497 | that task can be executed. Here is an example: do_configure[deptask] = |
@@ -1502,9 +1502,9 @@ execute. | |||
1502 | Runtime Dependencies | 1502 | Runtime Dependencies |
1503 | -------------------- | 1503 | -------------------- |
1504 | 1504 | ||
1505 | BitBake uses the ```PACKAGES`` <#var-bb-PACKAGES>`__, | 1505 | BitBake uses the :term:`PACKAGES`, |
1506 | ```RDEPENDS`` <#var-bb-RDEPENDS>`__, and | 1506 | :term:`RDEPENDS`, and |
1507 | ```RRECOMMENDS`` <#var-bb-RRECOMMENDS>`__ variables to manage runtime | 1507 | :term:`RRECOMMENDS` variables to manage runtime |
1508 | dependencies. | 1508 | dependencies. |
1509 | 1509 | ||
1510 | The ``PACKAGES`` variable lists runtime packages. Each of those packages | 1510 | The ``PACKAGES`` variable lists runtime packages. Each of those packages |
@@ -1670,7 +1670,7 @@ determine if a task needs to be run. This section describes the process. | |||
1670 | To help understand how BitBake does this, the section assumes an | 1670 | To help understand how BitBake does this, the section assumes an |
1671 | OpenEmbedded metadata-based example. | 1671 | OpenEmbedded metadata-based example. |
1672 | 1672 | ||
1673 | These checksums are stored in ```STAMP`` <#var-bb-STAMP>`__. You can | 1673 | These checksums are stored in :term:`STAMP`. You can |
1674 | examine the checksums using the following BitBake command: $ | 1674 | examine the checksums using the following BitBake command: $ |
1675 | bitbake-dumpsigs This command returns the signature data in a readable | 1675 | bitbake-dumpsigs This command returns the signature data in a readable |
1676 | format that allows you to examine the inputs used when the OpenEmbedded | 1676 | format that allows you to examine the inputs used when the OpenEmbedded |
@@ -1683,31 +1683,31 @@ Any changes to this variable would invalidate the stamp and cause the | |||
1683 | 1683 | ||
1684 | The following list describes related variables: | 1684 | The following list describes related variables: |
1685 | 1685 | ||
1686 | - ```BB_HASHCHECK_FUNCTION`` <#var-bb-BB_HASHCHECK_FUNCTION>`__: | 1686 | - :term:`BB_HASHCHECK_FUNCTION`: |
1687 | Specifies the name of the function to call during the "setscene" part | 1687 | Specifies the name of the function to call during the "setscene" part |
1688 | of the task's execution in order to validate the list of task hashes. | 1688 | of the task's execution in order to validate the list of task hashes. |
1689 | 1689 | ||
1690 | - ```BB_SETSCENE_DEPVALID`` <#var-bb-BB_SETSCENE_DEPVALID>`__: | 1690 | - :term:`BB_SETSCENE_DEPVALID`: |
1691 | Specifies a function BitBake calls that determines whether BitBake | 1691 | Specifies a function BitBake calls that determines whether BitBake |
1692 | requires a setscene dependency to be met. | 1692 | requires a setscene dependency to be met. |
1693 | 1693 | ||
1694 | - ```BB_SETSCENE_VERIFY_FUNCTION2`` <#var-bb-BB_SETSCENE_VERIFY_FUNCTION2>`__: | 1694 | - :term:`BB_SETSCENE_VERIFY_FUNCTION2`: |
1695 | Specifies a function to call that verifies the list of planned task | 1695 | Specifies a function to call that verifies the list of planned task |
1696 | execution before the main task execution happens. | 1696 | execution before the main task execution happens. |
1697 | 1697 | ||
1698 | - ```BB_STAMP_POLICY`` <#var-bb-BB_STAMP_POLICY>`__: Defines the mode | 1698 | - :term:`BB_STAMP_POLICY`: Defines the mode |
1699 | for comparing timestamps of stamp files. | 1699 | for comparing timestamps of stamp files. |
1700 | 1700 | ||
1701 | - ```BB_STAMP_WHITELIST`` <#var-bb-BB_STAMP_WHITELIST>`__: Lists stamp | 1701 | - :term:`BB_STAMP_WHITELIST`: Lists stamp |
1702 | files that are looked at when the stamp policy is "whitelist". | 1702 | files that are looked at when the stamp policy is "whitelist". |
1703 | 1703 | ||
1704 | - ```BB_TASKHASH`` <#var-bb-BB_TASKHASH>`__: Within an executing task, | 1704 | - :term:`BB_TASKHASH`: Within an executing task, |
1705 | this variable holds the hash of the task as returned by the currently | 1705 | this variable holds the hash of the task as returned by the currently |
1706 | enabled signature generator. | 1706 | enabled signature generator. |
1707 | 1707 | ||
1708 | - ```STAMP`` <#var-bb-STAMP>`__: The base path to create stamp files. | 1708 | - :term:`STAMP`: The base path to create stamp files. |
1709 | 1709 | ||
1710 | - ```STAMPCLEAN`` <#var-bb-STAMPCLEAN>`__: Again, the base path to | 1710 | - :term:`STAMPCLEAN`: Again, the base path to |
1711 | create stamp files but can use wildcards for matching a range of | 1711 | create stamp files but can use wildcards for matching a range of |
1712 | files for clean operations. | 1712 | files for clean operations. |
1713 | 1713 | ||
@@ -1718,10 +1718,10 @@ Support for wildcard use in variables varies depending on the context in | |||
1718 | which it is used. For example, some variables and file names allow | 1718 | which it is used. For example, some variables and file names allow |
1719 | limited use of wildcards through the "``%``" and "``*``" characters. | 1719 | limited use of wildcards through the "``%``" and "``*``" characters. |
1720 | Other variables or names support Python's | 1720 | Other variables or names support Python's |
1721 | ```glob`` <https://docs.python.org/3/library/glob.html>`__ syntax, | 1721 | ```glob`https://docs.python.org/3/library/glob.html syntax, |
1722 | ```fnmatch`` <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__ | 1722 | ```fnmatch`https://docs.python.org/3/library/fnmatch.html#module-fnmatch |
1723 | syntax, or | 1723 | syntax, or |
1724 | ```Regular Expression (re)`` <https://docs.python.org/3/library/re.html#re>`__ | 1724 | ```Regular Expression (re)`https://docs.python.org/3/library/re.html#re |
1725 | syntax. | 1725 | syntax. |
1726 | 1726 | ||
1727 | For variables that have wildcard suport, the documentation describes | 1727 | For variables that have wildcard suport, the documentation describes |