summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/new-recipe.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-03-02 19:40:23 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-03-20 13:16:52 +0000
commit8355326ffad023d886da163a2a03f6efb7941116 (patch)
tree1380f2912816560460644901b55350f8cbc231cd /documentation/dev-manual/new-recipe.rst
parent1f8322c8322543b7bb06df85e77355f99b5f8ecd (diff)
downloadpoky-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/new-recipe.rst')
-rw-r--r--documentation/dev-manual/new-recipe.rst26
1 files changed, 11 insertions, 15 deletions
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
258the Yocto Project Overview and Concepts Manual. 258the Yocto Project Overview and Concepts Manual.
259 259
260The :ref:`ref-tasks-fetch` task uses 260The :ref:`ref-tasks-fetch` task uses the prefix of each entry in the
261the prefix of each entry in the :term:`SRC_URI` variable value to determine 261:term:`SRC_URI` variable value to determine which
262which :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>`
263source files. It is the :term:`SRC_URI` variable that triggers the fetcher. 263to use to get your source files. It is the :term:`SRC_URI` variable that triggers
264The :ref:`ref-tasks-patch` task uses 264the fetcher. The :ref:`ref-tasks-patch` task uses the variable after source is
265the variable after source is fetched to apply patches. The OpenEmbedded 265fetched to apply patches. The OpenEmbedded build system uses
266build system uses 266:term:`FILESOVERRIDES` for scanning directory locations for local files in
267:term:`FILESOVERRIDES` for 267:term:`SRC_URI`.
268scanning directory locations for local files in :term:`SRC_URI`.
269 268
270The :term:`SRC_URI` variable in your recipe must define each unique location 269The :term:`SRC_URI` variable in your recipe must define each unique location
271for your source files. It is good practice to not hard-code version 270for 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