summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-09-23 17:45:40 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-10-07 10:54:25 +0100
commit6ade5d2d0ea95731c629af83d2d990ab86048d20 (patch)
treeeb6634337fdfa6d32bb37b77ea27b44e0acefc11 /documentation/dev-manual
parent5d1e8104cdec60d655b6bb289118f7b15a7fda14 (diff)
downloadpoky-6ade5d2d0ea95731c629af83d2d990ab86048d20.tar.gz
manuals: add reference to the "do_compile" task
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: e88f11002032e30bbe2dd0049e307a431a70aaef) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/common-tasks.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 9950ad364c..7e1cf1dd70 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -1826,8 +1826,8 @@ out-of-tree modules. Your recipe will also need the following::
1826Compilation 1826Compilation
1827----------- 1827-----------
1828 1828
1829During a build, the ``do_compile`` task happens after source is fetched, 1829During a build, the :ref:`ref-tasks-compile` task happens after source is fetched,
1830unpacked, and configured. If the recipe passes through ``do_compile`` 1830unpacked, and configured. If the recipe passes through :ref:`ref-tasks-compile`
1831successfully, nothing needs to be done. 1831successfully, nothing needs to be done.
1832 1832
1833However, if the compile step fails, you need to diagnose the failure. 1833However, if the compile step fails, you need to diagnose the failure.
@@ -2337,7 +2337,7 @@ Single .c File Package (Hello World!)
2337Building an application from a single file that is stored locally (e.g. 2337Building an application from a single file that is stored locally (e.g.
2338under ``files``) requires a recipe that has the file listed in the 2338under ``files``) requires a recipe that has the file listed in the
2339:term:`SRC_URI` variable. Additionally, you need to manually write the 2339:term:`SRC_URI` variable. Additionally, you need to manually write the
2340``do_compile`` and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the 2340:ref:`ref-tasks-compile` and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the
2341directory containing the source code, which is set to 2341directory containing the source code, which is set to
2342:term:`WORKDIR` in this case --- the 2342:term:`WORKDIR` in this case --- the
2343directory BitBake uses for the build. 2343directory BitBake uses for the build.
@@ -2401,7 +2401,7 @@ Makefile-Based Package
2401 2401
2402Applications that use GNU ``make`` also require a recipe that has the 2402Applications that use GNU ``make`` also require a recipe that has the
2403source archive listed in :term:`SRC_URI`. You do not need to add a 2403source archive listed in :term:`SRC_URI`. You do not need to add a
2404``do_compile`` step since by default BitBake starts the ``make`` command 2404:ref:`ref-tasks-compile` step since by default BitBake starts the ``make`` command
2405to compile the application. If you need additional ``make`` options, you 2405to compile the application. If you need additional ``make`` options, you
2406should store them in the 2406should store them in the
2407:term:`EXTRA_OEMAKE` or 2407:term:`EXTRA_OEMAKE` or
@@ -2551,7 +2551,7 @@ doing the following:
2551 ``${``\ :term:`S`\ ``}``. 2551 ``${``\ :term:`S`\ ``}``.
2552 2552
2553 If ``${S}`` might contain a Makefile, or if you inherit some class 2553 If ``${S}`` might contain a Makefile, or if you inherit some class
2554 that replaces :ref:`ref-tasks-configure` and ``do_compile`` with custom 2554 that replaces :ref:`ref-tasks-configure` and :ref:`ref-tasks-compile` with custom
2555 versions, then you can use the 2555 versions, then you can use the
2556 ``[``\ :ref:`noexec <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` 2556 ``[``\ :ref:`noexec <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
2557 flag to turn the tasks into no-ops, as follows:: 2557 flag to turn the tasks into no-ops, as follows::
@@ -3446,7 +3446,7 @@ Follow these general steps:
3446 you added to the patch. 3446 you added to the patch.
3447 3447
34486. *Test Your Changes:* Once you have modified the source code, the 34486. *Test Your Changes:* Once you have modified the source code, the
3449 easiest way to test your changes is by calling the ``do_compile`` 3449 easiest way to test your changes is by calling the :ref:`ref-tasks-compile`
3450 task as shown in the following example:: 3450 task as shown in the following example::
3451 3451
3452 $ bitbake -c compile -f package 3452 $ bitbake -c compile -f package
@@ -9594,7 +9594,7 @@ Running Specific Tasks
9594 9594
9595Any given recipe consists of a set of tasks. The standard BitBake 9595Any given recipe consists of a set of tasks. The standard BitBake
9596behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``, 9596behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``,
9597:ref:`ref-tasks-configure`, ``do_compile``, :ref:`ref-tasks-install`, ``do_package``, 9597:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, ``do_package``,
9598``do_package_write_*``, and :ref:`ref-tasks-build`. The default task is 9598``do_package_write_*``, and :ref:`ref-tasks-build`. The default task is
9599:ref:`ref-tasks-build` and any tasks on which it depends build first. Some tasks, 9599:ref:`ref-tasks-build` and any tasks on which it depends build first. Some tasks,
9600such as ``do_devshell``, are not part of the default build chain. If you 9600such as ``do_devshell``, are not part of the default build chain. If you
@@ -9637,7 +9637,7 @@ The following example shows one way you can use the ``-f`` option::
9637 9637
9638This sequence first builds and then recompiles ``matchbox-desktop``. The 9638This sequence first builds and then recompiles ``matchbox-desktop``. The
9639last command reruns all tasks (basically the packaging tasks) after the 9639last command reruns all tasks (basically the packaging tasks) after the
9640compile. BitBake recognizes that the ``do_compile`` task was rerun and 9640compile. BitBake recognizes that the :ref:`ref-tasks-compile` task was rerun and
9641therefore understands that the other tasks also need to be run again. 9641therefore understands that the other tasks also need to be run again.
9642 9642
9643Another, shorter way to rerun a task and all 9643Another, shorter way to rerun a task and all