diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-07-27 16:04:48 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-07-30 22:49:15 +0100 |
commit | 38496093d7e70145a054505f6d2f28ff7b270117 (patch) | |
tree | 748fb98a3296413824344c6ae1df248e2fce02d7 | |
parent | 1452ac11eed0b9a70049901c98587b95412cf0b7 (diff) | |
download | poky-38496093d7e70145a054505f6d2f28ff7b270117.tar.gz |
manuals: simplify references to BitBake manual
Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`"
by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`"
when the reference description is the same as the section name.
In this case, that's unnecessary to repeat the section name in the description part.
(From yocto-docs rev: 6a1a590f9ef77dc8842ea5945661135992eb94e1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 5 | ||||
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 2 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.4.rst | 4 | ||||
-rw-r--r-- | documentation/overview-manual/concepts.rst | 6 | ||||
-rw-r--r-- | documentation/ref-manual/tasks.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 12 | ||||
-rw-r--r-- | documentation/sdk-manual/extensible.rst | 2 |
7 files changed, 18 insertions, 17 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 8e2f2d423c..74167befad 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
@@ -267,8 +267,9 @@ an entire Linux distribution, including the toolchain, from source. | |||
267 | 267 | ||
268 | For information on using the ``bitbake`` command, see the | 268 | For information on using the ``bitbake`` command, see the |
269 | :ref:`overview-manual/concepts:bitbake` section in the Yocto Project Overview and | 269 | :ref:`overview-manual/concepts:bitbake` section in the Yocto Project Overview and |
270 | Concepts Manual, or see the ":ref:`BitBake Command | 270 | Concepts Manual, or see |
271 | <bitbake:bitbake-user-manual/bitbake-user-manual-intro:the bitbake command>`" section in the BitBake User Manual. | 271 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:the bitbake command` |
272 | in the BitBake User Manual. | ||
272 | 273 | ||
273 | #. **Simulate Your Image Using QEMU:** Once this particular image is | 274 | #. **Simulate Your Image Using QEMU:** Once this particular image is |
274 | built, you can start QEMU, which is a Quick EMUlator that ships with | 275 | built, you can start QEMU, which is a Quick EMUlator that ships with |
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 7a74d9e55d..c4b12c0a7e 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -9358,7 +9358,7 @@ log to ``${T}/log.do_``\ `task`, and can also log to standard output | |||
9358 | 9358 | ||
9359 | - ``bb.debug(level, msg)``: Writes "DEBUG: msg" to the | 9359 | - ``bb.debug(level, msg)``: Writes "DEBUG: msg" to the |
9360 | log. Also logs to stdout if the log level is greater than or equal to | 9360 | log. Also logs to stdout if the log level is greater than or equal to |
9361 | level. See the ":ref:`-D <bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax>`" option | 9361 | level. See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax`" option |
9362 | in the BitBake User Manual for more information. | 9362 | in the BitBake User Manual for more information. |
9363 | 9363 | ||
9364 | - ``bb.warn(msg)``: Writes "WARNING: msg" to the log while also | 9364 | - ``bb.warn(msg)``: Writes "WARNING: msg" to the log while also |
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst index cab81356d8..ae1a212b5d 100644 --- a/documentation/migration-guides/migration-2.4.rst +++ b/documentation/migration-guides/migration-2.4.rst | |||
@@ -286,8 +286,8 @@ 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:`Events <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events>`" section in the BitBake User | 289 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events`" |
290 | 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 |
293 | :term:`GCCPIE` variable with an option to enable | 293 | :term:`GCCPIE` variable with an option to enable |
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 1e5f0f9039..6377ebc000 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -74,7 +74,7 @@ versions of ``matchbox-desktop`` might exist. BitBake chooses the one | |||
74 | selected by the distribution configuration. You can get more details | 74 | selected by the distribution configuration. You can get more details |
75 | about how BitBake chooses between different target versions and | 75 | about how BitBake chooses between different target versions and |
76 | providers in the | 76 | providers in the |
77 | ":ref:`Preferences <bitbake:bitbake-user-manual/bitbake-user-manual-execution:preferences>`" section | 77 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:preferences`" section |
78 | of the BitBake User Manual. | 78 | of the BitBake User Manual. |
79 | 79 | ||
80 | BitBake also tries to execute any dependent tasks first. So for example, | 80 | BitBake also tries to execute any dependent tasks first. So for example, |
@@ -584,7 +584,7 @@ Source Control Managers (Optional) | |||
584 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 584 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
585 | 585 | ||
586 | Another place from which the build system can get source files is with | 586 | Another place from which the build system can get source files is with |
587 | :ref:`fetchers <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` employing various Source | 587 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers` employing various Source |
588 | Control Managers (SCMs) such as Git or Subversion. In such cases, a | 588 | Control Managers (SCMs) such as Git or Subversion. In such cases, a |
589 | repository is cloned or checked out. The | 589 | repository is cloned or checked out. The |
590 | :ref:`ref-tasks-fetch` task inside | 590 | :ref:`ref-tasks-fetch` task inside |
@@ -1863,7 +1863,7 @@ The following list explains the previous example: | |||
1863 | through the shared state cache if possible. If the task was | 1863 | through the shared state cache if possible. If the task was |
1864 | accelerated, ``sstate_setscene()`` returns True. Otherwise, it | 1864 | accelerated, ``sstate_setscene()`` returns True. Otherwise, it |
1865 | returns False, and the normal ``do_deploy`` task runs. For more | 1865 | returns False, and the normal ``do_deploy`` task runs. For more |
1866 | information, see the ":ref:`setscene <bitbake:bitbake-user-manual/bitbake-user-manual-execution:setscene>`" | 1866 | information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:setscene`" |
1867 | section in the BitBake User Manual. | 1867 | section in the BitBake User Manual. |
1868 | 1868 | ||
1869 | - The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates | 1869 | - The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates |
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 970b083942..ecc701856c 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:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and | 17 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and |
18 | ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the | 18 | ":ref:`bitbake: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: |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 3de37a1ab5..55121f2c5a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -256,7 +256,7 @@ system and gives an overview of their function and contents. | |||
256 | To add a tune to the list, be sure to append it with spaces using the | 256 | To add a tune to the list, be sure to append it with spaces using the |
257 | "+=" BitBake operator. Do not simply replace the list by using the | 257 | "+=" BitBake operator. Do not simply replace the list by using the |
258 | "=" operator. See the | 258 | "=" operator. See the |
259 | ":ref:`Basic Syntax <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax>`" section in the BitBake | 259 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" section in the BitBake |
260 | User Manual for more information. | 260 | User Manual for more information. |
261 | 261 | ||
262 | :term:`AZ_SAS` | 262 | :term:`AZ_SAS` |
@@ -1638,8 +1638,8 @@ system and gives an overview of their function and contents. | |||
1638 | 1638 | ||
1639 | For information on runtime dependencies, see the | 1639 | For information on runtime dependencies, see the |
1640 | :term:`RDEPENDS` variable. You can also see the | 1640 | :term:`RDEPENDS` variable. You can also see the |
1641 | ":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and | 1641 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and |
1642 | ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the | 1642 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the |
1643 | BitBake User Manual for additional information on tasks and | 1643 | BitBake User Manual for additional information on tasks and |
1644 | dependencies. | 1644 | dependencies. |
1645 | 1645 | ||
@@ -6105,8 +6105,8 @@ system and gives an overview of their function and contents. | |||
6105 | 6105 | ||
6106 | For information on build-time dependencies, see the | 6106 | For information on build-time dependencies, see the |
6107 | :term:`DEPENDS` variable. You can also see the | 6107 | :term:`DEPENDS` variable. You can also see the |
6108 | ":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and | 6108 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and |
6109 | ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the | 6109 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the |
6110 | BitBake User Manual for additional information on tasks and | 6110 | BitBake User Manual for additional information on tasks and |
6111 | dependencies. | 6111 | dependencies. |
6112 | 6112 | ||
@@ -6951,7 +6951,7 @@ system and gives an overview of their function and contents. | |||
6951 | protocols are highly dependent on particular BitBake Fetcher | 6951 | protocols are highly dependent on particular BitBake Fetcher |
6952 | submodules. Depending on the fetcher BitBake uses, various URL | 6952 | submodules. Depending on the fetcher BitBake uses, various URL |
6953 | parameters are employed. For specifics on the supported Fetchers, see | 6953 | parameters are employed. For specifics on the supported Fetchers, see |
6954 | the ":ref:`Fetchers <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`" section in the | 6954 | the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers`" section in the |
6955 | BitBake User Manual. | 6955 | BitBake User Manual. |
6956 | 6956 | ||
6957 | - ``file://`` - Fetches files, which are usually files shipped | 6957 | - ``file://`` - Fetches files, which are usually files shipped |
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index 5520a07184..2cdb06d65c 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst | |||
@@ -614,7 +614,7 @@ specify source code revision and versioning schemes, extract code into | |||
614 | or out of the ``devtool`` | 614 | or out of the ``devtool`` |
615 | :ref:`devtool-the-workspace-layer-structure`, | 615 | :ref:`devtool-the-workspace-layer-structure`, |
616 | and work with any source file forms that the | 616 | and work with any source file forms that the |
617 | :ref:`fetchers <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` support. | 617 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers` support. |
618 | 618 | ||
619 | The following diagram shows the common development flow used with the | 619 | The following diagram shows the common development flow used with the |
620 | ``devtool upgrade`` command: | 620 | ``devtool upgrade`` command: |