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/migration-guides | |
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/migration-guides')
7 files changed, 13 insertions, 14 deletions
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 |