mirror of
https://git.yoctoproject.org/poky
synced 2026-01-29 21:08:42 +01:00
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>
This commit is contained in:
committed by
Richard Purdie
parent
5d1e8104cd
commit
6ade5d2d0e
@@ -1826,8 +1826,8 @@ out-of-tree modules. Your recipe will also need the following::
|
||||
Compilation
|
||||
-----------
|
||||
|
||||
During a build, the ``do_compile`` task happens after source is fetched,
|
||||
unpacked, and configured. If the recipe passes through ``do_compile``
|
||||
During a build, the :ref:`ref-tasks-compile` task happens after source is fetched,
|
||||
unpacked, and configured. If the recipe passes through :ref:`ref-tasks-compile`
|
||||
successfully, nothing needs to be done.
|
||||
|
||||
However, if the compile step fails, you need to diagnose the failure.
|
||||
@@ -2337,7 +2337,7 @@ Single .c File Package (Hello World!)
|
||||
Building an application from a single file that is stored locally (e.g.
|
||||
under ``files``) requires a recipe that has the file listed in the
|
||||
:term:`SRC_URI` variable. Additionally, you need to manually write the
|
||||
``do_compile`` and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the
|
||||
:ref:`ref-tasks-compile` and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the
|
||||
directory containing the source code, which is set to
|
||||
:term:`WORKDIR` in this case --- the
|
||||
directory BitBake uses for the build.
|
||||
@@ -2401,7 +2401,7 @@ Makefile-Based Package
|
||||
|
||||
Applications that use GNU ``make`` also require a recipe that has the
|
||||
source archive listed in :term:`SRC_URI`. You do not need to add a
|
||||
``do_compile`` step since by default BitBake starts the ``make`` command
|
||||
:ref:`ref-tasks-compile` step since by default BitBake starts the ``make`` command
|
||||
to compile the application. If you need additional ``make`` options, you
|
||||
should store them in the
|
||||
:term:`EXTRA_OEMAKE` or
|
||||
@@ -2551,7 +2551,7 @@ doing the following:
|
||||
``${``\ :term:`S`\ ``}``.
|
||||
|
||||
If ``${S}`` might contain a Makefile, or if you inherit some class
|
||||
that replaces :ref:`ref-tasks-configure` and ``do_compile`` with custom
|
||||
that replaces :ref:`ref-tasks-configure` and :ref:`ref-tasks-compile` with custom
|
||||
versions, then you can use the
|
||||
``[``\ :ref:`noexec <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
|
||||
flag to turn the tasks into no-ops, as follows::
|
||||
@@ -3446,7 +3446,7 @@ Follow these general steps:
|
||||
you added to the patch.
|
||||
|
||||
6. *Test Your Changes:* Once you have modified the source code, the
|
||||
easiest way to test your changes is by calling the ``do_compile``
|
||||
easiest way to test your changes is by calling the :ref:`ref-tasks-compile`
|
||||
task as shown in the following example::
|
||||
|
||||
$ bitbake -c compile -f package
|
||||
@@ -9594,7 +9594,7 @@ Running Specific Tasks
|
||||
|
||||
Any given recipe consists of a set of tasks. The standard BitBake
|
||||
behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``,
|
||||
:ref:`ref-tasks-configure`, ``do_compile``, :ref:`ref-tasks-install`, ``do_package``,
|
||||
:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, ``do_package``,
|
||||
``do_package_write_*``, and :ref:`ref-tasks-build`. The default task is
|
||||
:ref:`ref-tasks-build` and any tasks on which it depends build first. Some tasks,
|
||||
such 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::
|
||||
|
||||
This sequence first builds and then recompiles ``matchbox-desktop``. The
|
||||
last command reruns all tasks (basically the packaging tasks) after the
|
||||
compile. BitBake recognizes that the ``do_compile`` task was rerun and
|
||||
compile. BitBake recognizes that the :ref:`ref-tasks-compile` task was rerun and
|
||||
therefore understands that the other tasks also need to be run again.
|
||||
|
||||
Another, shorter way to rerun a task and all
|
||||
|
||||
@@ -1209,7 +1209,7 @@ The build system has knowledge of the relationship between these tasks
|
||||
and other preceding tasks. For example, if BitBake runs
|
||||
``do_populate_sysroot_setscene`` for something, it does not make sense
|
||||
to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``,
|
||||
:ref:`ref-tasks-configure`, ``do_compile``, and :ref:`ref-tasks-install` tasks. However, if
|
||||
:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install` tasks. However, if
|
||||
``do_package`` needs to be run, BitBake needs to run those other tasks.
|
||||
|
||||
It becomes more complicated if everything can come from an sstate cache
|
||||
|
||||
@@ -2401,7 +2401,7 @@ uses these build systems, the recipe needs to inherit the ``setuptools3`` class.
|
||||
|
||||
.. note::
|
||||
|
||||
The ``setuptools3`` class ``do_compile()`` task now calls
|
||||
The ``setuptools3`` class :ref:`ref-tasks-compile` task now calls
|
||||
``setup.py bdist_wheel`` to build the ``wheel`` binary archive format
|
||||
(See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__).
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ directory set to ``${``\ :term:`B`\ ``}``.
|
||||
|
||||
The default behavior of this task is to run the ``oe_runmake`` function
|
||||
if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found.
|
||||
If no such file is found, the ``do_compile`` task does nothing.
|
||||
If no such file is found, the :ref:`ref-tasks-compile` task does nothing.
|
||||
|
||||
.. _ref-tasks-compile_ptest_base:
|
||||
|
||||
|
||||
@@ -5645,7 +5645,7 @@ system and gives an overview of their function and contents.
|
||||
.. note::
|
||||
|
||||
If the software being built experiences dependency issues during
|
||||
the ``do_compile`` task that result in race conditions, you can clear
|
||||
the :ref:`ref-tasks-compile` task that result in race conditions, you can clear
|
||||
the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For
|
||||
information on addressing race conditions, see the
|
||||
":ref:`dev-manual/common-tasks:debugging parallel make races`"
|
||||
|
||||
Reference in New Issue
Block a user