diff options
Diffstat (limited to 'documentation')
21 files changed, 150 insertions, 162 deletions
diff --git a/documentation/README b/documentation/README index c27ed86a33..e8aed86eb4 100644 --- a/documentation/README +++ b/documentation/README | |||
| @@ -357,13 +357,16 @@ The sphinx.ext.intersphinx extension is enabled by default | |||
| 357 | so that we can cross reference content from other Sphinx based | 357 | so that we can cross reference content from other Sphinx based |
| 358 | documentation projects, such as the BitBake manual. | 358 | documentation projects, such as the BitBake manual. |
| 359 | 359 | ||
| 360 | References to the BitBake manual can be done: | 360 | References to the BitBake manual can directly be done: |
| 361 | - With a specific description instead of the section name: | 361 | - With a specific description instead of the section name: |
| 362 | :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` | 362 | :ref:`Azure Storage fetcher (az://) <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` |
| 363 | - With the section name: | 363 | - With the section name: |
| 364 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option | 364 | :ref:`bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option |
| 365 | - Linking to the entire BitBake manual: | 365 | |
| 366 | :doc:`BitBake User Manual <bitbake:index>` | 366 | If you want to refer to an entire document (or chapter) in the BitBake manual, |
| 367 | you have to use the ":doc:" macro with the "bitbake:" prefix: | ||
| 368 | - :doc:`BitBake User Manual <bitbake:index>` | ||
| 369 | - :doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" chapter | ||
| 367 | 370 | ||
| 368 | Note that a reference to a variable (:term:`VARIABLE`) automatically points to | 371 | Note that a reference to a variable (:term:`VARIABLE`) automatically points to |
| 369 | the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary. | 372 | the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary. |
| @@ -372,6 +375,11 @@ BitBake manual as follows: | |||
| 372 | 375 | ||
| 373 | :term:`bitbake:BB_NUMBER_PARSE_THREADS` | 376 | :term:`bitbake:BB_NUMBER_PARSE_THREADS` |
| 374 | 377 | ||
| 378 | This would be the same if we had identical document filenames in | ||
| 379 | both the Yocto Project and BitBake manuals: | ||
| 380 | |||
| 381 | :ref:`bitbake:directory/file:section title` | ||
| 382 | |||
| 375 | Submitting documentation changes | 383 | Submitting documentation changes |
| 376 | ================================ | 384 | ================================ |
| 377 | 385 | ||
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index cfdd14ae4a..c8310e0066 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
| @@ -262,7 +262,7 @@ an entire Linux distribution, including the toolchain, from source. | |||
| 262 | For information on using the ``bitbake`` command, see the | 262 | For information on using the ``bitbake`` command, see the |
| 263 | :ref:`overview-manual/concepts:bitbake` section in the Yocto Project Overview and | 263 | :ref:`overview-manual/concepts:bitbake` section in the Yocto Project Overview and |
| 264 | Concepts Manual, or see | 264 | Concepts Manual, or see |
| 265 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:the bitbake command` | 265 | :ref:`bitbake-user-manual/bitbake-user-manual-intro:the bitbake command` |
| 266 | in the BitBake User Manual. | 266 | in the BitBake User Manual. |
| 267 | 267 | ||
| 268 | #. **Simulate Your Image Using QEMU:** Once this particular image is | 268 | #. **Simulate Your Image Using QEMU:** Once this particular image is |
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index 9fb159eae6..3c5609cef5 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst | |||
| @@ -108,7 +108,7 @@ Viewing Variable Values | |||
| 108 | Sometimes you need to know the value of a variable as a result of | 108 | Sometimes you need to know the value of a variable as a result of |
| 109 | BitBake's parsing step. This could be because some unexpected behavior | 109 | BitBake's parsing step. This could be because some unexpected behavior |
| 110 | occurred in your project. Perhaps an attempt to :ref:`modify a variable | 110 | occurred in your project. Perhaps an attempt to :ref:`modify a variable |
| 111 | <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:modifying existing | 111 | <bitbake-user-manual/bitbake-user-manual-metadata:modifying existing |
| 112 | variables>` did not work out as expected. | 112 | variables>` did not work out as expected. |
| 113 | 113 | ||
| 114 | BitBake's ``-e`` option is used to display variable values after | 114 | BitBake's ``-e`` option is used to display variable values after |
| @@ -282,15 +282,14 @@ Viewing Task Variable Dependencies | |||
| 282 | ================================== | 282 | ================================== |
| 283 | 283 | ||
| 284 | As mentioned in the | 284 | As mentioned in the |
| 285 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`" section of the BitBake | 285 | ":ref:`bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`" |
| 286 | User Manual, BitBake tries to automatically determine what variables a | 286 | section of the BitBake User Manual, BitBake tries to automatically determine |
| 287 | task depends on so that it can rerun the task if any values of the | 287 | what variables a task depends on so that it can rerun the task if any values of |
| 288 | variables change. This determination is usually reliable. However, if | 288 | the variables change. This determination is usually reliable. However, if you |
| 289 | you do things like construct variable names at runtime, then you might | 289 | do things like construct variable names at runtime, then you might have to |
| 290 | have to manually declare dependencies on those variables using | 290 | manually declare dependencies on those variables using ``vardeps`` as described |
| 291 | ``vardeps`` as described in the | 291 | in the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" |
| 292 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" section of the BitBake | 292 | section of the BitBake User Manual. |
| 293 | User Manual. | ||
| 294 | 293 | ||
| 295 | If you are unsure whether a variable dependency is being picked up | 294 | If you are unsure whether a variable dependency is being picked up |
| 296 | automatically for a given task, you can list the variable dependencies | 295 | automatically for a given task, you can list the variable dependencies |
| @@ -457,7 +456,7 @@ out), then you can use the ``-f`` option. | |||
| 457 | 456 | ||
| 458 | The reason ``-f`` is never required when running the | 457 | The reason ``-f`` is never required when running the |
| 459 | :ref:`ref-tasks-devshell` task is because the | 458 | :ref:`ref-tasks-devshell` task is because the |
| 460 | [\ :ref:`nostamp <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ] | 459 | [\ :ref:`nostamp <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ] |
| 461 | variable flag is already set for the task. | 460 | variable flag is already set for the task. |
| 462 | 461 | ||
| 463 | The following example shows one way you can use the ``-f`` option:: | 462 | The following example shows one way you can use the ``-f`` option:: |
| @@ -572,10 +571,10 @@ log to ``${T}/log.do_``\ `task`, and can also log to standard output | |||
| 572 | - ``bb.note(msg)``: Writes "NOTE: msg" to the log. Also logs to | 571 | - ``bb.note(msg)``: Writes "NOTE: msg" to the log. Also logs to |
| 573 | stdout if BitBake is called with "-v". | 572 | stdout if BitBake is called with "-v". |
| 574 | 573 | ||
| 575 | - ``bb.debug(level, msg)``: Writes "DEBUG: msg" to the | 574 | - ``bb.debug(level, msg)``: Writes "DEBUG: msg" to the log. Also logs to |
| 576 | log. Also logs to stdout if the log level is greater than or equal to | 575 | stdout if the log level is greater than or equal to level. See the |
| 577 | level. See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax`" option | 576 | ":ref:`bitbake-user-manual/bitbake-user-manual-intro:usage and syntax`" |
| 578 | in the BitBake User Manual for more information. | 577 | option in the BitBake User Manual for more information. |
| 579 | 578 | ||
| 580 | - ``bb.warn(msg)``: Writes "WARNING: msg" to the log while also | 579 | - ``bb.warn(msg)``: Writes "WARNING: msg" to the log while also |
| 581 | logging to stdout. | 580 | logging to stdout. |
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst index 1ed217be7f..4e74246a4e 100644 --- a/documentation/dev-manual/new-recipe.rst +++ b/documentation/dev-manual/new-recipe.rst | |||
| @@ -257,15 +257,14 @@ located. For a graphical representation of source locations, see the | |||
| 257 | ":ref:`overview-manual/concepts:sources`" section in | 257 | ":ref:`overview-manual/concepts:sources`" section in |
| 258 | the Yocto Project Overview and Concepts Manual. | 258 | the Yocto Project Overview and Concepts Manual. |
| 259 | 259 | ||
| 260 | The :ref:`ref-tasks-fetch` task uses | 260 | The :ref:`ref-tasks-fetch` task uses the prefix of each entry in the |
| 261 | the prefix of each entry in the :term:`SRC_URI` variable value to determine | 261 | :term:`SRC_URI` variable value to determine which |
| 262 | which :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` to use to get your | 262 | :ref:`fetcher <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` |
| 263 | source files. It is the :term:`SRC_URI` variable that triggers the fetcher. | 263 | to use to get your source files. It is the :term:`SRC_URI` variable that triggers |
| 264 | The :ref:`ref-tasks-patch` task uses | 264 | the fetcher. The :ref:`ref-tasks-patch` task uses the variable after source is |
| 265 | the variable after source is fetched to apply patches. The OpenEmbedded | 265 | fetched to apply patches. The OpenEmbedded build system uses |
| 266 | build system uses | 266 | :term:`FILESOVERRIDES` for scanning directory locations for local files in |
| 267 | :term:`FILESOVERRIDES` for | 267 | :term:`SRC_URI`. |
| 268 | scanning directory locations for local files in :term:`SRC_URI`. | ||
| 269 | 268 | ||
| 270 | The :term:`SRC_URI` variable in your recipe must define each unique location | 269 | The :term:`SRC_URI` variable in your recipe must define each unique location |
| 271 | for your source files. It is good practice to not hard-code version | 270 | for your source files. It is good practice to not hard-code version |
| @@ -1422,12 +1421,9 @@ doing the following: | |||
| 1422 | do_configure[noexec] = "1" | 1421 | do_configure[noexec] = "1" |
| 1423 | do_compile[noexec] = "1" | 1422 | do_compile[noexec] = "1" |
| 1424 | 1423 | ||
| 1425 | Unlike | 1424 | Unlike :ref:`bitbake-user-manual/bitbake-user-manual-metadata:deleting a task`, |
| 1426 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:deleting a task`, | 1425 | using the flag preserves the dependency chain from the :ref:`ref-tasks-fetch`, |
| 1427 | using the flag preserves the dependency chain from the | 1426 | :ref:`ref-tasks-unpack`, and :ref:`ref-tasks-patch` tasks to the |
| 1428 | :ref:`ref-tasks-fetch`, | ||
| 1429 | :ref:`ref-tasks-unpack`, and | ||
| 1430 | :ref:`ref-tasks-patch` tasks to the | ||
| 1431 | :ref:`ref-tasks-install` task. | 1427 | :ref:`ref-tasks-install` task. |
| 1432 | 1428 | ||
| 1433 | - Make sure your :ref:`ref-tasks-install` task installs the binaries | 1429 | - Make sure your :ref:`ref-tasks-install` task installs the binaries |
diff --git a/documentation/dev-manual/packages.rst b/documentation/dev-manual/packages.rst index 0c584c177a..90c52beb29 100644 --- a/documentation/dev-manual/packages.rst +++ b/documentation/dev-manual/packages.rst | |||
| @@ -999,12 +999,12 @@ test. Here is what you have to do for each recipe: | |||
| 999 | Creating Node Package Manager (NPM) Packages | 999 | Creating Node Package Manager (NPM) Packages |
| 1000 | ============================================ | 1000 | ============================================ |
| 1001 | 1001 | ||
| 1002 | :wikipedia:`NPM <Npm_(software)>` is a package | 1002 | :wikipedia:`NPM <Npm_(software)>` is a package manager for the JavaScript |
| 1003 | manager for the JavaScript programming language. The Yocto Project | 1003 | programming language. The Yocto Project supports the NPM |
| 1004 | supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can | 1004 | :ref:`fetcher <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. |
| 1005 | use this fetcher in combination with | 1005 | You can use this fetcher in combination with |
| 1006 | :doc:`devtool </ref-manual/devtool-reference>` to create | 1006 | :doc:`devtool </ref-manual/devtool-reference>` to create recipes that produce |
| 1007 | recipes that produce NPM packages. | 1007 | NPM packages. |
| 1008 | 1008 | ||
| 1009 | There are two workflows that allow you to create NPM packages using | 1009 | There are two workflows that allow you to create NPM packages using |
| 1010 | ``devtool``: the NPM registry modules method and the NPM project code | 1010 | ``devtool``: the NPM registry modules method and the NPM project code |
diff --git a/documentation/dev-manual/python-development-shell.rst b/documentation/dev-manual/python-development-shell.rst index 1b213318a5..2dc6a3f138 100644 --- a/documentation/dev-manual/python-development-shell.rst +++ b/documentation/dev-manual/python-development-shell.rst | |||
| @@ -27,7 +27,7 @@ functions:: | |||
| 27 | pydevshell> bb.build.exec_func("do_unpack", d) | 27 | pydevshell> bb.build.exec_func("do_unpack", d) |
| 28 | pydevshell> | 28 | pydevshell> |
| 29 | 29 | ||
| 30 | See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:functions you can call from within python`" | 30 | See the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:functions you can call from within python`" |
| 31 | section in the BitBake User Manual for details about available functions. | 31 | section in the BitBake User Manual for details about available functions. |
| 32 | 32 | ||
| 33 | The commands execute just as if the OpenEmbedded build | 33 | The commands execute just as if the OpenEmbedded build |
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst index a8734900a0..35195135c4 100644 --- a/documentation/kernel-dev/advanced.rst +++ b/documentation/kernel-dev/advanced.rst | |||
| @@ -352,17 +352,15 @@ in the manual. | |||
| 352 | Kernel Types | 352 | Kernel Types |
| 353 | ------------ | 353 | ------------ |
| 354 | 354 | ||
| 355 | A kernel type defines a high-level kernel policy by aggregating | 355 | A kernel type defines a high-level kernel policy by aggregating non-hardware |
| 356 | non-hardware configuration fragments with patches you want to use when | 356 | configuration fragments with patches you want to use when building a Linux |
| 357 | building a Linux kernel of a specific type (e.g. a real-time kernel). | 357 | kernel of a specific type (e.g. a real-time kernel). Syntactically, kernel |
| 358 | Syntactically, kernel types are no different than features as described | 358 | types are no different than features as described in the |
| 359 | in the ":ref:`kernel-dev/advanced:features`" section. The | 359 | ":ref:`kernel-dev/advanced:features`" section. The :term:`LINUX_KERNEL_TYPE` |
| 360 | :term:`LINUX_KERNEL_TYPE` | 360 | variable in the kernel recipe selects the kernel type. For example, in the |
| 361 | variable in the kernel recipe selects the kernel type. For example, in | 361 | ``linux-yocto_4.12.bb`` kernel recipe found in ``poky/meta/recipes-kernel/linux``, a |
| 362 | the ``linux-yocto_4.12.bb`` kernel recipe found in | 362 | :ref:`require <bitbake-user-manual/bitbake-user-manual-metadata:\`\`require\`\` directive>` |
| 363 | ``poky/meta/recipes-kernel/linux``, a | 363 | directive includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file, |
| 364 | :ref:`require <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`require\`\` directive>` directive | ||
| 365 | includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file, | ||
| 366 | which has the following statement that defines the default kernel type:: | 364 | which has the following statement that defines the default kernel type:: |
| 367 | 365 | ||
| 368 | LINUX_KERNEL_TYPE ??= "standard" | 366 | LINUX_KERNEL_TYPE ??= "standard" |
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index 2d4f4d603e..5435835102 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst | |||
| @@ -121,11 +121,10 @@ compared to uClibc. | |||
| 121 | ``${B}`` No Longer Default Working Directory for Tasks | 121 | ``${B}`` No Longer Default Working Directory for Tasks |
| 122 | ------------------------------------------------------ | 122 | ------------------------------------------------------ |
| 123 | 123 | ||
| 124 | ``${``\ :term:`B`\ ``}`` is no longer the default working | 124 | ``${``\ :term:`B`\ ``}`` is no longer the default working directory for tasks. |
| 125 | directory for tasks. Consequently, any custom tasks you define now need | 125 | Consequently, any custom tasks you define now need to either have the |
| 126 | to either have the | 126 | ``[``\ :ref:`dirs <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` |
| 127 | ``[``\ :ref:`dirs <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` flag | 127 | flag set, or the task needs to change into the appropriate working directory |
| 128 | set, or the task needs to change into the appropriate working directory | ||
| 129 | manually (e.g using ``cd`` for a shell task). | 128 | manually (e.g using ``cd`` for a shell task). |
| 130 | 129 | ||
| 131 | .. note:: | 130 | .. note:: |
diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst index 38117d41b4..60340b9592 100644 --- a/documentation/migration-guides/migration-2.3.rst +++ b/documentation/migration-guides/migration-2.3.rst | |||
| @@ -198,9 +198,9 @@ The following changes took place for BitBake: | |||
| 198 | fetcher passes the new parameter through the ``SVN_SSH`` environment | 198 | fetcher passes the new parameter through the ``SVN_SSH`` environment |
| 199 | variable during the :ref:`ref-tasks-fetch` task. | 199 | variable during the :ref:`ref-tasks-fetch` task. |
| 200 | 200 | ||
| 201 | See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:subversion (svn) fetcher (\`\`svn://\`\`)`" | 201 | See the |
| 202 | section in the BitBake | 202 | ":ref:`bitbake-user-manual/bitbake-user-manual-fetching:subversion (svn) fetcher (\`\`svn://\`\`)`" |
| 203 | User Manual for additional information. | 203 | section in the BitBake User Manual for additional information. |
| 204 | 204 | ||
| 205 | - ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2`` | 205 | - ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2`` |
| 206 | Removed: Because the mechanism they were part of is no longer | 206 | Removed: Because the mechanism they were part of is no longer |
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst index 9637301a47..abad43acc3 100644 --- a/documentation/migration-guides/migration-2.4.rst +++ b/documentation/migration-guides/migration-2.4.rst | |||
| @@ -286,7 +286,7 @@ The following are additional changes: | |||
| 286 | 286 | ||
| 287 | - BitBake fires multiple "BuildStarted" events when multiconfig is | 287 | - BitBake fires multiple "BuildStarted" events when multiconfig is |
| 288 | enabled (one per configuration). For more information, see the | 288 | enabled (one per configuration). For more information, see the |
| 289 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events`" | 289 | ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:events`" |
| 290 | section in the BitBake User Manual. | 290 | section in the BitBake User Manual. |
| 291 | 291 | ||
| 292 | - By default, the ``security_flags.inc`` file sets a | 292 | - By default, the ``security_flags.inc`` file sets a |
diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst index 477714b489..dd21eb3baf 100644 --- a/documentation/migration-guides/migration-2.6.rst +++ b/documentation/migration-guides/migration-2.6.rst | |||
| @@ -274,7 +274,7 @@ The following changes have occurred: | |||
| 274 | specifying list items to remove, be aware that leading and trailing | 274 | specifying list items to remove, be aware that leading and trailing |
| 275 | whitespace resulting from the removal is retained. | 275 | whitespace resulting from the removal is retained. |
| 276 | 276 | ||
| 277 | See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`" | 277 | See the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`" |
| 278 | section in the BitBake User Manual for a detailed example. | 278 | section in the BitBake User Manual for a detailed example. |
| 279 | 279 | ||
| 280 | .. _migration-2.6-systemd-configuration-now-split-out-to-system-conf: | 280 | .. _migration-2.6-systemd-configuration-now-split-out-to-system-conf: |
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index 076c589c8c..a80d43a86b 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst | |||
| @@ -45,7 +45,7 @@ would now become:: | |||
| 45 | BB_TASK_NICE_LEVEL:task-testimage = '0' | 45 | BB_TASK_NICE_LEVEL:task-testimage = '0' |
| 46 | 46 | ||
| 47 | This also applies to | 47 | This also applies to |
| 48 | :ref:`variable queries to the datastore <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:functions for accessing datastore variables>`, | 48 | :ref:`variable queries to the datastore <bitbake-user-manual/bitbake-user-manual-metadata:functions for accessing datastore variables>`, |
| 49 | for example using ``getVar`` and similar so ``d.getVar("RDEPENDS_${PN}")`` | 49 | for example using ``getVar`` and similar so ``d.getVar("RDEPENDS_${PN}")`` |
| 50 | becomes ``d.getVar("RDEPENDS:${PN}")``. | 50 | becomes ``d.getVar("RDEPENDS:${PN}")``. |
| 51 | 51 | ||
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst index 3106498404..2aa9145ef8 100644 --- a/documentation/migration-guides/migration-4.0.rst +++ b/documentation/migration-guides/migration-4.0.rst | |||
| @@ -207,8 +207,8 @@ For the ``append`` plus ``+=`` (and ``prepend`` plus ``=+``) combinations, | |||
| 207 | the content should be prefixed (respectively suffixed) by a space to maintain | 207 | the content should be prefixed (respectively suffixed) by a space to maintain |
| 208 | the same behavior. You can learn more about override style syntax operators | 208 | the same behavior. You can learn more about override style syntax operators |
| 209 | (``append``, ``prepend`` and ``remove``) in the BitBake documentation: | 209 | (``append``, ``prepend`` and ``remove``) in the BitBake documentation: |
| 210 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)` | 210 | :ref:`bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)` |
| 211 | and :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`. | 211 | and :ref:`bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`. |
| 212 | 212 | ||
| 213 | Miscellaneous changes | 213 | Miscellaneous changes |
| 214 | ~~~~~~~~~~~~~~~~~~~~~ | 214 | ~~~~~~~~~~~~~~~~~~~~~ |
diff --git a/documentation/migration-guides/release-notes-4.0.rst b/documentation/migration-guides/release-notes-4.0.rst index 563113b4db..6eb5f807de 100644 --- a/documentation/migration-guides/release-notes-4.0.rst +++ b/documentation/migration-guides/release-notes-4.0.rst | |||
| @@ -115,7 +115,7 @@ New Features / Enhancements in 4.0 | |||
| 115 | 115 | ||
| 116 | - Fetcher enhancements: | 116 | - Fetcher enhancements: |
| 117 | 117 | ||
| 118 | - New :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages | 118 | - New :ref:`bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages |
| 119 | - Added striplevel support to unpack | 119 | - Added striplevel support to unpack |
| 120 | - git: Add a warning asking users to set a branch in git urls | 120 | - git: Add a warning asking users to set a branch in git urls |
| 121 | - git: Allow git fetcher to support subdir param | 121 | - git: Allow git fetcher to support subdir param |
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index a7a0efd6e9..e7551149a1 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
| @@ -69,12 +69,10 @@ type the following:: | |||
| 69 | 69 | ||
| 70 | $ bitbake matchbox-desktop | 70 | $ bitbake matchbox-desktop |
| 71 | 71 | ||
| 72 | Several different | 72 | Several different versions of ``matchbox-desktop`` might exist. BitBake chooses |
| 73 | versions of ``matchbox-desktop`` might exist. BitBake chooses the one | 73 | the one selected by the distribution configuration. You can get more details |
| 74 | selected by the distribution configuration. You can get more details | 74 | about how BitBake chooses between different target versions and providers in the |
| 75 | about how BitBake chooses between different target versions and | 75 | ":ref:`bitbake-user-manual/bitbake-user-manual-execution:preferences`" section |
| 76 | providers in the | ||
| 77 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:preferences`" section | ||
| 78 | of the BitBake User Manual. | 76 | of the BitBake User Manual. |
| 79 | 77 | ||
| 80 | BitBake also tries to execute any dependent tasks first. So for example, | 78 | BitBake also tries to execute any dependent tasks first. So for example, |
| @@ -570,13 +568,11 @@ Source Control Managers (Optional) | |||
| 570 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 568 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 571 | 569 | ||
| 572 | Another place from which the build system can get source files is with | 570 | Another place from which the build system can get source files is with |
| 573 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers` employing various Source | 571 | :ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers` employing |
| 574 | Control Managers (SCMs) such as Git or Subversion. In such cases, a | 572 | various Source Control Managers (SCMs) such as Git or Subversion. In such |
| 575 | repository is cloned or checked out. The | 573 | cases, a repository is cloned or checked out. The :ref:`ref-tasks-fetch` task |
| 576 | :ref:`ref-tasks-fetch` task inside | 574 | inside BitBake uses the :term:`SRC_URI` variable and the argument's prefix to |
| 577 | BitBake uses the :term:`SRC_URI` | 575 | determine the correct fetcher module. |
| 578 | variable and the argument's prefix to determine the correct fetcher | ||
| 579 | module. | ||
| 580 | 576 | ||
| 581 | .. note:: | 577 | .. note:: |
| 582 | 578 | ||
| @@ -1145,7 +1141,7 @@ Since :term:`STAMPS_DIR` is usually a subdirectory of :term:`TMPDIR`, removing | |||
| 1145 | properly be rerun to repopulate :term:`TMPDIR`. | 1141 | properly be rerun to repopulate :term:`TMPDIR`. |
| 1146 | 1142 | ||
| 1147 | If you want some task to always be considered "out of date", you can | 1143 | If you want some task to always be considered "out of date", you can |
| 1148 | mark it with the :ref:`nostamp <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>` | 1144 | mark it with the :ref:`nostamp <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>` |
| 1149 | varflag. If some other task depends on such a task, then that task will | 1145 | varflag. If some other task depends on such a task, then that task will |
| 1150 | also always be considered out of date, which might not be what you want. | 1146 | also always be considered out of date, which might not be what you want. |
| 1151 | 1147 | ||
| @@ -1811,19 +1807,18 @@ The following list explains the previous example: | |||
| 1811 | } | 1807 | } |
| 1812 | addtask do_deploy_setscene | 1808 | addtask do_deploy_setscene |
| 1813 | 1809 | ||
| 1814 | ``sstate_setscene()`` takes the flags above as input and accelerates the :ref:`ref-tasks-deploy` task | 1810 | ``sstate_setscene()`` takes the flags above as input and accelerates the |
| 1815 | through the shared state cache if possible. If the task was | 1811 | :ref:`ref-tasks-deploy` task through the shared state cache if possible. If |
| 1816 | accelerated, ``sstate_setscene()`` returns True. Otherwise, it | 1812 | the task was accelerated, ``sstate_setscene()`` returns True. Otherwise, it |
| 1817 | returns False, and the normal :ref:`ref-tasks-deploy` task runs. For more | 1813 | returns False, and the normal :ref:`ref-tasks-deploy` task runs. For more |
| 1818 | information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:setscene`" | 1814 | information, see the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:setscene`" |
| 1819 | section in the BitBake User Manual. | 1815 | section in the BitBake User Manual. |
| 1820 | 1816 | ||
| 1821 | - The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates | 1817 | - The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates ``${DEPLOYDIR}`` |
| 1822 | ``${DEPLOYDIR}`` and ``${B}`` before the :ref:`ref-tasks-deploy` task runs, and | 1818 | and ``${B}`` before the :ref:`ref-tasks-deploy` task runs, and also sets the |
| 1823 | also sets the current working directory of :ref:`ref-tasks-deploy` to ``${B}``. | 1819 | current working directory of :ref:`ref-tasks-deploy` to ``${B}``. For more |
| 1824 | For more information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" | 1820 | information, see the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" |
| 1825 | section in the BitBake | 1821 | section in the BitBake User Manual. |
| 1826 | User Manual. | ||
| 1827 | 1822 | ||
| 1828 | .. note:: | 1823 | .. note:: |
| 1829 | 1824 | ||
| @@ -1835,12 +1830,10 @@ The following list explains the previous example: | |||
| 1835 | do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}" | 1830 | do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}" |
| 1836 | 1831 | ||
| 1837 | 1832 | ||
| 1838 | - The ``do_deploy[stamp-extra-info] = "${MACHINE_ARCH}"`` line appends | 1833 | - The ``do_deploy[stamp-extra-info] = "${MACHINE_ARCH}"`` line appends extra |
| 1839 | extra metadata to the :ref:`stamp | 1834 | metadata to the :ref:`stamp file <overview-manual/concepts:stamp files and the rerunning of tasks>`. |
| 1840 | file <overview-manual/concepts:stamp files and the rerunning of tasks>`. In | 1835 | In this case, the metadata makes the task specific to a machine's architecture. |
| 1841 | this case, the metadata makes the task specific to a machine's architecture. | 1836 | See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:the task list`" |
| 1842 | See | ||
| 1843 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:the task list`" | ||
| 1844 | section in the BitBake User Manual for more information on the | 1837 | section in the BitBake User Manual for more information on the |
| 1845 | ``stamp-extra-info`` flag. | 1838 | ``stamp-extra-info`` flag. |
| 1846 | 1839 | ||
| @@ -2122,12 +2115,12 @@ dependencies, you must manually declare the dependencies. | |||
| 2122 | :term:`ALLOW_EMPTY` variable | 2115 | :term:`ALLOW_EMPTY` variable |
| 2123 | for more information. | 2116 | for more information. |
| 2124 | 2117 | ||
| 2125 | The :ref:`ref-tasks-package` task depends on the :ref:`ref-tasks-packagedata` task of each | 2118 | The :ref:`ref-tasks-package` task depends on the :ref:`ref-tasks-packagedata` |
| 2126 | recipe in :term:`DEPENDS` through use | 2119 | task of each recipe in :term:`DEPENDS` through use of a |
| 2127 | of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` | 2120 | ``[``\ :ref:`deptask <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` |
| 2128 | declaration, which guarantees that the required | 2121 | declaration, which guarantees that the required shared-library / |
| 2129 | shared-library/module-to-package mapping information will be available | 2122 | module-to-package mapping information will be available when needed as long as |
| 2130 | when needed as long as :term:`DEPENDS` has been correctly set. | 2123 | :term:`DEPENDS` has been correctly set. |
| 2131 | 2124 | ||
| 2132 | Fakeroot and Pseudo | 2125 | Fakeroot and Pseudo |
| 2133 | =================== | 2126 | =================== |
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 35f5345ad4..d694642af2 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
| @@ -704,7 +704,7 @@ BitBake also supports both ``:prepend`` and ``:append`` operators as a | |||
| 704 | method of extending task functionality. These operators inject code into | 704 | method of extending task functionality. These operators inject code into |
| 705 | the beginning or end of a task. For information on these BitBake | 705 | the beginning or end of a task. For information on these BitBake |
| 706 | operators, see the | 706 | operators, see the |
| 707 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)`" | 707 | ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)`" |
| 708 | section in the BitBake User's Manual. | 708 | section in the BitBake User's Manual. |
| 709 | 709 | ||
| 710 | The OpenEmbedded Build System Workflow | 710 | The OpenEmbedded Build System Workflow |
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 32e64d02a2..e167f58092 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
| @@ -353,7 +353,7 @@ variables in package recipes. | |||
| 353 | :yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>` | 353 | :yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>` |
| 354 | file. | 354 | file. |
| 355 | 355 | ||
| 356 | - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` | 356 | - If the recipe is using the :ref:`bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` |
| 357 | rather than a tarball, the commit hash points to the commit that matches | 357 | rather than a tarball, the commit hash points to the commit that matches |
| 358 | the recipe's latest version tag, or in the absence of suitable tags, | 358 | the recipe's latest version tag, or in the absence of suitable tags, |
| 359 | to the latest commit (when :term:`UPSTREAM_CHECK_COMMITS` set to ``1`` | 359 | to the latest commit (when :term:`UPSTREAM_CHECK_COMMITS` set to ``1`` |
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 7a664cc6c0..f2b93185af 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
| @@ -14,8 +14,8 @@ Normal Recipe Build Tasks | |||
| 14 | 14 | ||
| 15 | The following sections describe normal tasks associated with building a | 15 | The following sections describe normal tasks associated with building a |
| 16 | recipe. For more information on tasks and dependencies, see the | 16 | recipe. For more information on tasks and dependencies, see the |
| 17 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and | 17 | ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and |
| 18 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the | 18 | ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the |
| 19 | BitBake User Manual. | 19 | BitBake User Manual. |
| 20 | 20 | ||
| 21 | .. _ref-tasks-build: | 21 | .. _ref-tasks-build: |
| @@ -118,9 +118,9 @@ If the :ref:`ref-tasks-deploy` task re-executes, any previous output is removed | |||
| 118 | ``do_fetch`` | 118 | ``do_fetch`` |
| 119 | ------------ | 119 | ------------ |
| 120 | 120 | ||
| 121 | Fetches the source code. This task uses the | 121 | Fetches the source code. This task uses the :term:`SRC_URI` variable and the |
| 122 | :term:`SRC_URI` variable and the argument's prefix to | 122 | argument's prefix to determine the correct |
| 123 | determine the correct :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` | 123 | :ref:`fetcher <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` |
| 124 | module. | 124 | module. |
| 125 | 125 | ||
| 126 | .. _ref-tasks-image: | 126 | .. _ref-tasks-image: |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 2e32e264db..6c59ffee5f 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -243,12 +243,12 @@ system and gives an overview of their function and contents. | |||
| 243 | To add a tune to the list, be sure to append it with spaces using the | 243 | To add a tune to the list, be sure to append it with spaces using the |
| 244 | "+=" BitBake operator. Do not simply replace the list by using the | 244 | "+=" BitBake operator. Do not simply replace the list by using the |
| 245 | "=" operator. See the | 245 | "=" operator. See the |
| 246 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" section in the BitBake | 246 | ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" section in the BitBake |
| 247 | User Manual for more information. | 247 | User Manual for more information. |
| 248 | 248 | ||
| 249 | :term:`AZ_SAS` | 249 | :term:`AZ_SAS` |
| 250 | Azure Storage Shared Access Signature, when using the | 250 | Azure Storage Shared Access Signature, when using the |
| 251 | :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` | 251 | :ref:`Azure Storage fetcher (az://) <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` |
| 252 | This variable can be defined to be used by the fetcher to authenticate | 252 | This variable can be defined to be used by the fetcher to authenticate |
| 253 | and gain access to non-public artifacts:: | 253 | and gain access to non-public artifacts:: |
| 254 | 254 | ||
| @@ -1833,15 +1833,14 @@ system and gives an overview of their function and contents. | |||
| 1833 | 1833 | ||
| 1834 | DEPENDS = "bar" | 1834 | DEPENDS = "bar" |
| 1835 | 1835 | ||
| 1836 | The practical effect of the previous | 1836 | The practical effect of the previous assignment is that all files |
| 1837 | assignment is that all files installed by bar will be available in | 1837 | installed by bar will be available in the appropriate staging sysroot, |
| 1838 | the appropriate staging sysroot, given by the | 1838 | given by the :term:`STAGING_DIR* <STAGING_DIR>` variables, by the time |
| 1839 | :term:`STAGING_DIR* <STAGING_DIR>` variables, by the time the | 1839 | the :ref:`ref-tasks-configure` task for ``foo`` runs. This mechanism is |
| 1840 | :ref:`ref-tasks-configure` task for ``foo`` runs. | 1840 | implemented by having :ref:`ref-tasks-configure` depend on the |
| 1841 | This mechanism is implemented by having :ref:`ref-tasks-configure` depend on | 1841 | :ref:`ref-tasks-populate_sysroot` task of each recipe listed in |
| 1842 | the :ref:`ref-tasks-populate_sysroot` task of | 1842 | :term:`DEPENDS`, through a |
| 1843 | each recipe listed in :term:`DEPENDS`, through a | 1843 | ``[``\ :ref:`deptask <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` |
| 1844 | ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` | ||
| 1845 | declaration in the :ref:`ref-classes-base` class. | 1844 | declaration in the :ref:`ref-classes-base` class. |
| 1846 | 1845 | ||
| 1847 | .. note:: | 1846 | .. note:: |
| @@ -1888,12 +1887,12 @@ system and gives an overview of their function and contents. | |||
| 1888 | to the recipe that installs ``libbar``, other recipes might | 1887 | to the recipe that installs ``libbar``, other recipes might |
| 1889 | fail to link against ``libfoo``. | 1888 | fail to link against ``libfoo``. |
| 1890 | 1889 | ||
| 1891 | For information on runtime dependencies, see the | 1890 | For information on runtime dependencies, see the :term:`RDEPENDS` |
| 1892 | :term:`RDEPENDS` variable. You can also see the | 1891 | variable. You can also see the |
| 1893 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and | 1892 | ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and |
| 1894 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the | 1893 | ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" |
| 1895 | BitBake User Manual for additional information on tasks and | 1894 | sections in the BitBake User Manual for additional information on tasks |
| 1896 | dependencies. | 1895 | and dependencies. |
| 1897 | 1896 | ||
| 1898 | :term:`DEPLOY_DIR` | 1897 | :term:`DEPLOY_DIR` |
| 1899 | Points to the general area that the OpenEmbedded build system uses to | 1898 | Points to the general area that the OpenEmbedded build system uses to |
| @@ -2817,15 +2816,13 @@ system and gives an overview of their function and contents. | |||
| 2817 | recipe to correctly extend the path. | 2816 | recipe to correctly extend the path. |
| 2818 | 2817 | ||
| 2819 | :term:`FILESOVERRIDES` | 2818 | :term:`FILESOVERRIDES` |
| 2820 | A subset of :term:`OVERRIDES` used by the | 2819 | A subset of :term:`OVERRIDES` used by the OpenEmbedded build system for |
| 2821 | OpenEmbedded build system for creating | 2820 | creating :term:`FILESPATH`. The :term:`FILESOVERRIDES` variable uses |
| 2822 | :term:`FILESPATH`. The :term:`FILESOVERRIDES` variable | 2821 | overrides to automatically extend the :term:`FILESPATH` variable. For an |
| 2823 | uses overrides to automatically extend the | 2822 | example of how that works, see the :term:`FILESPATH` variable |
| 2824 | :term:`FILESPATH` variable. For an example of how | ||
| 2825 | that works, see the :term:`FILESPATH` variable | ||
| 2826 | description. Additionally, you find more information on how overrides | 2823 | description. Additionally, you find more information on how overrides |
| 2827 | are handled in the | 2824 | are handled in the |
| 2828 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" | 2825 | ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" |
| 2829 | section of the BitBake User Manual. | 2826 | section of the BitBake User Manual. |
| 2830 | 2827 | ||
| 2831 | By default, the :term:`FILESOVERRIDES` variable is defined as:: | 2828 | By default, the :term:`FILESOVERRIDES` variable is defined as:: |
| @@ -3547,19 +3544,19 @@ system and gives an overview of their function and contents. | |||
| 3547 | section in the Yocto Project Development Tasks Manual. | 3544 | section in the Yocto Project Development Tasks Manual. |
| 3548 | 3545 | ||
| 3549 | - Using :term:`IMAGE_INSTALL` with the | 3546 | - Using :term:`IMAGE_INSTALL` with the |
| 3550 | :ref:`+= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending (+=) and prepending (=+) with spaces>` | 3547 | :ref:`+= <bitbake-user-manual/bitbake-user-manual-metadata:appending (+=) and prepending (=+) with spaces>` |
| 3551 | BitBake operator within the ``/conf/local.conf`` file or from | 3548 | BitBake operator within the ``/conf/local.conf`` file or from |
| 3552 | within an image recipe is not recommended. Use of this operator | 3549 | within an image recipe is not recommended. Use of this operator in |
| 3553 | in these ways can cause ordering issues. Since | 3550 | these ways can cause ordering issues. Since |
| 3554 | :ref:`ref-classes-core-image` sets :term:`IMAGE_INSTALL` to a default | 3551 | :ref:`ref-classes-core-image` sets :term:`IMAGE_INSTALL` to a |
| 3555 | value using the | 3552 | default value using the |
| 3556 | :ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>` | 3553 | :ref:`?= <bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>` |
| 3557 | operator, using a ``+=`` operation against :term:`IMAGE_INSTALL` | 3554 | operator, using a ``+=`` operation against :term:`IMAGE_INSTALL` |
| 3558 | results in unexpected behavior when used within | 3555 | results in unexpected behavior when used within |
| 3559 | ``conf/local.conf``. Furthermore, the same operation from | 3556 | ``conf/local.conf``. Furthermore, the same operation from within an |
| 3560 | within an image recipe may or may not succeed depending on the | 3557 | image recipe may or may not succeed depending on the specific |
| 3561 | specific situation. In both these cases, the behavior is | 3558 | situation. In both these cases, the behavior is contrary to how |
| 3562 | contrary to how most users expect the ``+=`` operator to work. | 3559 | most users expect the ``+=`` operator to work. |
| 3563 | 3560 | ||
| 3564 | :term:`IMAGE_LINGUAS` | 3561 | :term:`IMAGE_LINGUAS` |
| 3565 | Specifies the list of locales to install into the image during the | 3562 | Specifies the list of locales to install into the image during the |
| @@ -3921,7 +3918,7 @@ system and gives an overview of their function and contents. | |||
| 3921 | ``classes-global/`` or ``classes/`` subdirectories. | 3918 | ``classes-global/`` or ``classes/`` subdirectories. |
| 3922 | 3919 | ||
| 3923 | For more information on :term:`INHERIT`, see the | 3920 | For more information on :term:`INHERIT`, see the |
| 3924 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" | 3921 | :ref:`bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" |
| 3925 | section in the BitBake User Manual. | 3922 | section in the BitBake User Manual. |
| 3926 | 3923 | ||
| 3927 | :term:`INHERIT_DISTRO` | 3924 | :term:`INHERIT_DISTRO` |
| @@ -5619,7 +5616,7 @@ system and gives an overview of their function and contents. | |||
| 5619 | FOO:an-override = "overridden" | 5616 | FOO:an-override = "overridden" |
| 5620 | 5617 | ||
| 5621 | See the | 5618 | See the |
| 5622 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" | 5619 | ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" |
| 5623 | section in the BitBake User Manual for more information on the | 5620 | section in the BitBake User Manual for more information on the |
| 5624 | overrides mechanism. | 5621 | overrides mechanism. |
| 5625 | 5622 | ||
| @@ -6824,12 +6821,11 @@ system and gives an overview of their function and contents. | |||
| 6824 | 6821 | ||
| 6825 | RDEPENDS:${PN} = "foo (>= 1.2)" | 6822 | RDEPENDS:${PN} = "foo (>= 1.2)" |
| 6826 | 6823 | ||
| 6827 | For information on build-time dependencies, see the | 6824 | For information on build-time dependencies, see the :term:`DEPENDS` |
| 6828 | :term:`DEPENDS` variable. You can also see the | 6825 | variable. You can also see the |
| 6829 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and | 6826 | ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and |
| 6830 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the | 6827 | ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the |
| 6831 | BitBake User Manual for additional information on tasks and | 6828 | BitBake User Manual for additional information on tasks and dependencies. |
| 6832 | dependencies. | ||
| 6833 | 6829 | ||
| 6834 | :term:`RECIPE_NO_UPDATE_REASON` | 6830 | :term:`RECIPE_NO_UPDATE_REASON` |
| 6835 | If a recipe should not be replaced by a more recent upstream version, | 6831 | If a recipe should not be replaced by a more recent upstream version, |
diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst index 2be76875e0..61091d83ba 100644 --- a/documentation/sdk-manual/appendix-customizing.rst +++ b/documentation/sdk-manual/appendix-customizing.rst | |||
| @@ -77,7 +77,7 @@ adjustments: | |||
| 77 | either define the entire list by using the "=" operator, or you | 77 | either define the entire list by using the "=" operator, or you |
| 78 | will need to append a value using either ":append" or the "+=" | 78 | will need to append a value using either ":append" or the "+=" |
| 79 | operator. You can learn more about these operators in the | 79 | operator. You can learn more about these operators in the |
| 80 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" | 80 | ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" |
| 81 | section of the BitBake User Manual. | 81 | section of the BitBake User Manual. |
| 82 | 82 | ||
| 83 | - If you have classes or recipes that add additional tasks to the | 83 | - If you have classes or recipes that add additional tasks to the |
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index 7c7ceb695a..9e08e57a4e 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst | |||
| @@ -651,12 +651,11 @@ counterparts. | |||
| 651 | :ref:`dev-manual/upgrading-recipes:upgrading recipes` section | 651 | :ref:`dev-manual/upgrading-recipes:upgrading recipes` section |
| 652 | of the Yocto Project Development Tasks Manual. | 652 | of the Yocto Project Development Tasks Manual. |
| 653 | 653 | ||
| 654 | The ``devtool upgrade`` command is flexible enough to allow you to | 654 | The ``devtool upgrade`` command is flexible enough to allow you to specify |
| 655 | specify source code revision and versioning schemes, extract code into | 655 | source code revision and versioning schemes, extract code into or out of the |
| 656 | or out of the ``devtool`` | 656 | ``devtool`` :ref:`devtool-the-workspace-layer-structure`, and work with any |
| 657 | :ref:`devtool-the-workspace-layer-structure`, | 657 | source file forms that the |
| 658 | and work with any source file forms that the | 658 | :ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers` support. |
| 659 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers` support. | ||
| 660 | 659 | ||
| 661 | The following diagram shows the common development flow used with the | 660 | The following diagram shows the common development flow used with the |
| 662 | ``devtool upgrade`` command: | 661 | ``devtool upgrade`` command: |
