diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-03-02 19:40:23 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-03-20 13:16:52 +0000 |
commit | 8355326ffad023d886da163a2a03f6efb7941116 (patch) | |
tree | 1380f2912816560460644901b55350f8cbc231cd /documentation/dev-manual | |
parent | 1f8322c8322543b7bb06df85e77355f99b5f8ecd (diff) | |
download | poky-8355326ffad023d886da163a2a03f6efb7941116.tar.gz |
manuals: simplify references to the BitBake User Manual
- Replacing
:ref:`bitbake:bitbake-user-manual/...`
by :ref:`bitbake-user-manual/...`
Adding "bitbake:" as a prefix is not necessary
as there is no naming conflict between the YP
and the BitBake manuals (all documents are in
"bitbake-user-manual/")
- Explaining the rules in the README file
- When necessary, fixing line length in the modified paragraphs.
(From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/debugging.rst | 29 | ||||
-rw-r--r-- | documentation/dev-manual/new-recipe.rst | 26 | ||||
-rw-r--r-- | documentation/dev-manual/packages.rst | 12 | ||||
-rw-r--r-- | documentation/dev-manual/python-development-shell.rst | 2 |
4 files changed, 32 insertions, 37 deletions
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 |