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/overview-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/overview-manual')
| -rw-r--r-- | documentation/overview-manual/concepts.rst | 69 | ||||
| -rw-r--r-- | documentation/overview-manual/yp-intro.rst | 2 |
2 files changed, 32 insertions, 39 deletions
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 |
