mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-31 12:49:46 +00:00
Code Issues Projects Releases Wiki Activity

dev-manual, kernel-dev, ref-manual: Updated task name usage.

Browse Source 
There was inconsistency on how we refer to a task name throughout
the YP manual set.  The proper way is "do_<taskname>".  Some
occurrences did not include the "do_" prefix.  These have been
fixed.

(From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2014-06-11 10:46:05 +03:00
committed by Richard Purdie
parent 50af2dc537
commit a19f575cde
8 changed files with 88 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/ref-classes.xml
+3 -3
View File
@@ -569,7 +569,7 @@
<para>
The <filename>devshell</filename> class adds the
<filename>devshell</filename> task.
<filename>do_devshell</filename> task.
Distribution policy dictates whether to include this class.
See the
"<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section
@@ -606,8 +606,8 @@
provides for automatic checking for upstream recipe updates.
The class creates a comma-separated value (CSV) spreadsheet that
contains information about the recipes.
The information provides the <filename>distrodata</filename> and
<filename>distro_check</filename> tasks, which do upstream checking
The information provides the <filename>do_distrodata</filename> and
<filename>do_distro_check</filename> tasks, which do upstream checking
and also verify if a package is used in multiple major distributions.
</para>
documentation/ref-manual/ref-structure.xml
+3 -2
View File
@@ -800,8 +800,9 @@
<para>
This directory contains general logs that are not otherwise placed using the
package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>.
Examples of logs are the output from the <filename>check_pkg</filename> or
<filename>distro_check</filename> tasks.
Examples of logs are the output from the
<filename>do_check_pkg</filename> or
<filename>do_distro_check</filename> tasks.
Running a build does not necessarily mean this directory is created.
</para>
</section>
documentation/ref-manual/ref-variables.xml
+1 -1
View File
@@ -7796,7 +7796,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Instead, files should be installed to
<filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename>
within your recipe's
<link linkend='ref-tasks-install'><filename>install</filename></link>
<link linkend='ref-tasks-install'><filename>do_install</filename></link>
task and then the OpenEmbedded build system will
stage a subset of those files into the sysroot.
</note>
documentation/ref-manual/technical-details.xml
+2 -2
View File
@@ -442,11 +442,11 @@
works on a per-task basis rather than a per-recipe basis.
You might wonder why using a per-task basis is preferred over a per-recipe basis.
To help explain, consider having the IPK packaging backend enabled and then switching to DEB.
In this case,
In this case, the
<link linkend='ref-tasks-install'><filename>do_install</filename></link>
and
<link linkend='ref-tasks-package'><filename>do_package</filename></link>
outputs are still valid.
task outputs are still valid.
However, with a per-recipe approach, the build would not include the
<filename>.deb</filename> files.
Consequently, you would have to invalidate the whole build and rerun it.
documentation/ref-manual/usingpoky.xml
+20 -15
View File
@@ -173,17 +173,20 @@
<para>
Any given package consists of a set of tasks.
The standard BitBake behavior in most cases is: <filename>fetch</filename>,
<filename>unpack</filename>,
<filename>patch</filename>, <filename>configure</filename>,
<filename>compile</filename>, <filename>install</filename>, <filename>package</filename>,
<filename>package_write</filename>, and <filename>build</filename>.
The default task is <filename>build</filename> and any tasks on which it depends
build first.
Some tasks, such as <filename>devshell</filename>, are not part of the
default build chain.
If you wish to run a task that is not part of the default build chain, you can use the
<filename>-c</filename> option in BitBake.
The standard BitBake behavior in most cases is:
<filename>do_fetch</filename>,
<filename>do_unpack</filename>,
<filename>do_patch</filename>, <filename>do_configure</filename>,
<filename>do_compile</filename>, <filename>do_install</filename>,
<filename>do_package</filename>,
<filename>do_package_write</filename>, and
<filename>do_build</filename>.
The default task is <filename>do_build</filename> and any tasks
on which it depends build first.
Some tasks, such as <filename>do_devshell</filename>, are not part
of the default build chain.
If you wish to run a task that is not part of the default build
chain, you can use the <filename>-c</filename> option in BitBake.
Here is an example:
<literallayout class='monospaced'>
$ bitbake matchbox-desktop -c devshell
@@ -210,14 +213,16 @@
<para>
This sequence first builds and then recompiles
<filename>matchbox-desktop</filename>.
The last command reruns all tasks (basically the packaging tasks) after the compile.
BitBake recognizes that the <filename>compile</filename> task was rerun and therefore
understands that the other tasks also need to be run again.
The last command reruns all tasks (basically the packaging tasks)
after the compile.
BitBake recognizes that the <filename>do_compile</filename>
task was rerun and therefore understands that the other tasks
also need to be run again.
</para>
<para>
You can view a list of tasks in a given package by running the
<filename>listtasks</filename> task as follows:
<filename>do_listtasks</filename> task as follows:
<literallayout class='monospaced'>
$ bitbake matchbox-desktop -c listtasks
</literallayout>