summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-tasks.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-tasks.rst')
-rw-r--r--documentation/ref-manual/ref-tasks.rst63
1 files changed, 23 insertions, 40 deletions
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index ea145644f7..12320b7ef9 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -87,33 +87,30 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``.
87 87
88.. note:: 88.. note::
89 89
90 Do not write the output directly to 90 Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes
91 ${DEPLOY_DIR_IMAGE} 91 the sstate mechanism to malfunction.
92 , as this causes the sstate mechanism to malfunction.
93 92
94The ``do_deploy`` task is not added as a task by default and 93The ``do_deploy`` task is not added as a task by default and
95consequently needs to be added manually. If you want the task to run 94consequently needs to be added manually. If you want the task to run
96after :ref:`ref-tasks-compile`, you can add it by doing 95after :ref:`ref-tasks-compile`, you can add it by doing
97the following: addtask deploy after do_compile Adding ``do_deploy`` 96the following:
98after other tasks works the same way. 97::
98
99 addtask deploy after do_compile
100
101Adding ``do_deploy`` after other tasks works the same way.
99 102
100.. note:: 103.. note::
101 104
102 You do not need to add 105 You do not need to add ``before do_build`` to the ``addtask`` command
103 before do_build 106 (though it is harmless), because the ``base`` class contains the following:
104 to the
105 addtask
106 command (though it is harmless), because the
107 base
108 class contains the following:
109 :: 107 ::
110 108
111 do_build[recrdeptask] += "do_deploy" 109 do_build[recrdeptask] += "do_deploy"
112 110
113 111
114 See the " 112 See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`"
115 Dependencies 113 section in the BitBake User Manual for more information.
116 " section in the BitBake User Manual for more information.
117 114
118If the ``do_deploy`` task re-executes, any previous output is removed 115If the ``do_deploy`` task re-executes, any previous output is removed
119(i.e. "cleaned"). 116(i.e. "cleaned").
@@ -298,10 +295,8 @@ to locate and apply patch files to the source code.
298 295
299.. note:: 296.. note::
300 297
301 The build system uses the 298 The build system uses the :term:`FILESPATH` variable to determine the
302 FILESPATH 299 default set of directories when searching for patches.
303 variable to determine the default set of directories when searching
304 for patches.
305 300
306Patch files, by default, are ``*.patch`` and ``*.diff`` files created 301Patch files, by default, are ``*.patch`` and ``*.diff`` files created
307and kept in a subdirectory of the directory holding the recipe file. For 302and kept in a subdirectory of the directory holding the recipe file. For
@@ -322,13 +317,8 @@ and patch files needed to build the package.
322 317
323.. note:: 318.. note::
324 319
325 In the case for the 320 In the case for the ``bluez5_5.48.bb`` recipe, the ``SRC_URI`` statements
326 bluez5_5.48.bb 321 are from an include file ``bluez5.inc``.
327 recipe, the
328 SRC_URI
329 statements are from an include file
330 bluez5.inc
331 .
332 322
333As mentioned earlier, the build system treats files whose file types are 323As mentioned earlier, the build system treats files whose file types are
334``.patch`` and ``.diff`` as patch files. However, you can use the 324``.patch`` and ``.diff`` as patch files. However, you can use the
@@ -356,7 +346,7 @@ the patch phase, you can use the "apply=no" parameter with the
356In the 346In the
357previous example, assuming all the files in the directory holding the 347previous example, assuming all the files in the directory holding the
358patch files end with either ``.patch`` or ``.diff``, every file would be 348patch files end with either ``.patch`` or ``.diff``, every file would be
359applied as a patch by default except for the patch_file5 patch. 349applied as a patch by default except for the ``patch_file5`` patch.
360 350
361You can find out more about the patching process in the 351You can find out more about the patching process in the
362":ref:`patching-dev-environment`" section in 352":ref:`patching-dev-environment`" section in
@@ -561,11 +551,9 @@ scratch is guaranteed.
561 551
562.. note:: 552.. note::
563 553
564 The 554 The ``do_cleansstate`` task cannot remove sstate from a remote sstate
565 do_cleansstate 555 mirror. If you need to build a target from scratch using remote mirrors, use
566 task cannot remove sstate from a remote sstate mirror. If you need to 556 the "-f" option as follows:
567 build a target from scratch using remote mirrors, use the "-f" option
568 as follows:
569 :: 557 ::
570 558
571 $ bitbake -f -c do_cleansstate target 559 $ bitbake -f -c do_cleansstate target
@@ -609,14 +597,9 @@ Creates or updates the index in the `:ref:`package-feeds-dev-environment` area.
609 597
610.. note:: 598.. note::
611 599
612 This task is not triggered with the 600 This task is not triggered with the ``bitbake -c`` command-line option as
613 bitbake -c 601 are the other tasks in this section. Because this task is specifically for
614 command-line option as are the other tasks in this section. Because 602 the ``package-index`` recipe, you run it using ``bitbake package-index``.
615 this task is specifically for the
616 package-index
617 recipe, you run it using
618 bitbake package-index
619 .
620 603
621Image-Related Tasks 604Image-Related Tasks
622=================== 605===================