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/ref-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/ref-manual')
-rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/tasks.rst | 10 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 80 |
3 files changed, 44 insertions, 48 deletions
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, |