diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.rst')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.rst | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst index 953d853374..c9b8a834cf 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.rst +++ b/documentation/dev-manual/dev-manual-common-tasks.rst | |||
@@ -1163,7 +1163,7 @@ the Yocto Project Overview and Concepts Manual. | |||
1163 | 1163 | ||
1164 | The :ref:`ref-tasks-fetch` task uses | 1164 | The :ref:`ref-tasks-fetch` task uses |
1165 | the prefix of each entry in the ``SRC_URI`` variable value to determine | 1165 | the prefix of each entry in the ``SRC_URI`` variable value to determine |
1166 | which `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ to use to get your | 1166 | which :ref:`fetcher <bitbake:bb-fetchers>` to use to get your |
1167 | source files. It is the ``SRC_URI`` variable that triggers the fetcher. | 1167 | source files. It is the ``SRC_URI`` variable that triggers the fetcher. |
1168 | The :ref:`ref-tasks-patch` task uses | 1168 | The :ref:`ref-tasks-patch` task uses |
1169 | the variable after source is fetched to apply patches. The OpenEmbedded | 1169 | the variable after source is fetched to apply patches. The OpenEmbedded |
@@ -2302,10 +2302,10 @@ doing the following: | |||
2302 | If ``${S}`` might contain a Makefile, or if you inherit some class | 2302 | If ``${S}`` might contain a Makefile, or if you inherit some class |
2303 | that replaces ``do_configure`` and ``do_compile`` with custom | 2303 | that replaces ``do_configure`` and ``do_compile`` with custom |
2304 | versions, then you can use the | 2304 | versions, then you can use the |
2305 | ``[``\ ```noexec`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` | 2305 | ``[``\ :ref:`noexec <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` |
2306 | flag to turn the tasks into no-ops, as follows: do_configure[noexec] | 2306 | flag to turn the tasks into no-ops, as follows: do_configure[noexec] |
2307 | = "1" do_compile[noexec] = "1" Unlike | 2307 | = "1" do_compile[noexec] = "1" Unlike |
2308 | ```deleting the tasks`` <&YOCTO_DOCS_BB_URL;#deleting-a-task>`__, | 2308 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:deleting a task`, |
2309 | using the flag preserves the dependency chain from the | 2309 | using the flag preserves the dependency chain from the |
2310 | :ref:`ref-tasks-fetch`, | 2310 | :ref:`ref-tasks-fetch`, |
2311 | :ref:`ref-tasks-unpack`, and | 2311 | :ref:`ref-tasks-unpack`, and |
@@ -2341,8 +2341,8 @@ Recipe Syntax | |||
2341 | 2341 | ||
2342 | Understanding recipe file syntax is important for writing recipes. The | 2342 | Understanding recipe file syntax is important for writing recipes. The |
2343 | following list overviews the basic items that make up a BitBake recipe | 2343 | following list overviews the basic items that make up a BitBake recipe |
2344 | file. For more complete BitBake syntax descriptions, see the "`Syntax | 2344 | file. For more complete BitBake syntax descriptions, see the |
2345 | and Operators <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata>`__" | 2345 | ":doc:`bitbake-user-manual/bitbake-user-manual-metadata`" |
2346 | chapter of the BitBake User Manual. | 2346 | chapter of the BitBake User Manual. |
2347 | 2347 | ||
2348 | - *Variable Assignments and Manipulations:* Variable assignments allow | 2348 | - *Variable Assignments and Manipulations:* Variable assignments allow |
@@ -2385,8 +2385,8 @@ chapter of the BitBake User Manual. | |||
2385 | 2385 | ||
2386 | This next list summarizes the most important and most commonly used | 2386 | This next list summarizes the most important and most commonly used |
2387 | parts of the recipe syntax. For more information on these parts of the | 2387 | parts of the recipe syntax. For more information on these parts of the |
2388 | syntax, you can reference the `Syntax and | 2388 | syntax, you can reference the |
2389 | Operators <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata>`__ chapter | 2389 | :doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata` chapter |
2390 | in the BitBake User Manual. | 2390 | in the BitBake User Manual. |
2391 | 2391 | ||
2392 | - *Line Continuation (\):* Use the backward slash (``\``) character to | 2392 | - *Line Continuation (\):* Use the backward slash (``\``) character to |
@@ -6661,7 +6661,7 @@ Creating Node Package Manager (NPM) Packages | |||
6661 | 6661 | ||
6662 | `NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__ is a package | 6662 | `NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__ is a package |
6663 | manager for the JavaScript programming language. The Yocto Project | 6663 | manager for the JavaScript programming language. The Yocto Project |
6664 | supports the NPM `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__. You can | 6664 | supports the NPM :ref:`fetcher <bitbake:bb-fetchers>`. You can |
6665 | use this fetcher in combination with | 6665 | use this fetcher in combination with |
6666 | ```devtool`` <&YOCTO_DOCS_REF_URL;#ref-devtool-reference>`__ to create | 6666 | ```devtool`` <&YOCTO_DOCS_REF_URL;#ref-devtool-reference>`__ to create |
6667 | recipes that produce NPM packages. | 6667 | recipes that produce NPM packages. |
@@ -8239,9 +8239,9 @@ Viewing Variable Values | |||
8239 | 8239 | ||
8240 | Sometimes you need to know the value of a variable as a result of | 8240 | Sometimes you need to know the value of a variable as a result of |
8241 | BitBake's parsing step. This could be because some unexpected behavior | 8241 | BitBake's parsing step. This could be because some unexpected behavior |
8242 | occurred in your project. Perhaps an attempt to `modify a | 8242 | occurred in your project. Perhaps an attempt to :ref:`modify a variable |
8243 | variable <&YOCTO_DOCS_BB_URL;#modifying-existing-variables>`__ did not | 8243 | <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:modifying existing |
8244 | work out as expected. | 8244 | variables>` did not work out as expected. |
8245 | 8245 | ||
8246 | BitBake's ``-e`` option is used to display variable values after | 8246 | BitBake's ``-e`` option is used to display variable values after |
8247 | parsing. The following command displays the variable values after the | 8247 | parsing. The following command displays the variable values after the |
@@ -8404,15 +8404,15 @@ dependencies for the recipes involved in building recipename. | |||
8404 | Viewing Task Variable Dependencies | 8404 | Viewing Task Variable Dependencies |
8405 | ---------------------------------- | 8405 | ---------------------------------- |
8406 | 8406 | ||
8407 | As mentioned in the "`Checksums | 8407 | As mentioned in the |
8408 | (Signatures) <&YOCTO_DOCS_BB_URL;#checksums>`__" section of the BitBake | 8408 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`" section of the BitBake |
8409 | User Manual, BitBake tries to automatically determine what variables a | 8409 | User Manual, BitBake tries to automatically determine what variables a |
8410 | task depends on so that it can rerun the task if any values of the | 8410 | task depends on so that it can rerun the task if any values of the |
8411 | variables change. This determination is usually reliable. However, if | 8411 | variables change. This determination is usually reliable. However, if |
8412 | you do things like construct variable names at runtime, then you might | 8412 | you do things like construct variable names at runtime, then you might |
8413 | have to manually declare dependencies on those variables using | 8413 | have to manually declare dependencies on those variables using |
8414 | ``vardeps`` as described in the "`Variable | 8414 | ``vardeps`` as described in the |
8415 | Flags <&YOCTO_DOCS_BB_URL;#variable-flags>`__" section of the BitBake | 8415 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" section of the BitBake |
8416 | User Manual. | 8416 | User Manual. |
8417 | 8417 | ||
8418 | If you are unsure whether a variable dependency is being picked up | 8418 | If you are unsure whether a variable dependency is being picked up |
@@ -8691,7 +8691,7 @@ log to ``${T}/log.do_``\ task, and can also log to standard output | |||
8691 | 8691 | ||
8692 | - ``bb.debug(``\ level\ ``, ``\ msg\ ``)``: Writes "DEBUG: msg" to the | 8692 | - ``bb.debug(``\ level\ ``, ``\ msg\ ``)``: Writes "DEBUG: msg" to the |
8693 | log. Also logs to stdout if the log level is greater than or equal to | 8693 | log. Also logs to stdout if the log level is greater than or equal to |
8694 | level. See the "`-D <&YOCTO_DOCS_BB_URL;#usage-and-syntax>`__" option | 8694 | level. See the ":ref:`-D <bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax>`" option |
8695 | in the BitBake User Manual for more information. | 8695 | in the BitBake User Manual for more information. |
8696 | 8696 | ||
8697 | - ``bb.warn(``\ msg\ ``)``: Writes "WARNING: msg" to the log while also | 8697 | - ``bb.warn(``\ msg\ ``)``: Writes "WARNING: msg" to the log while also |