diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-06-11 10:46:05 +0300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-06-18 10:30:48 +0100 |
commit | a19f575cde39917e4632dab1e813d84402f95937 (patch) | |
tree | 856fc2d185f4eef07af46a14f1e659285793e42b | |
parent | 50af2dc53778c712c21538f82025427d558cba63 (diff) | |
download | poky-a19f575cde39917e4632dab1e813d84402f95937.tar.gz |
dev-manual, kernel-dev, ref-manual: Updated task name usage.
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>
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 79 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 12 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-common.xml | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 6 | ||||
-rw-r--r-- | documentation/ref-manual/ref-structure.xml | 5 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 2 | ||||
-rw-r--r-- | documentation/ref-manual/technical-details.xml | 4 | ||||
-rw-r--r-- | documentation/ref-manual/usingpoky.xml | 35 |
8 files changed, 88 insertions, 57 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 0c66a7c232..3922c8f0f4 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -3548,7 +3548,7 @@ | |||
3548 | 3548 | ||
3549 | <para> | 3549 | <para> |
3550 | As part of the kernel build process, the | 3550 | As part of the kernel build process, the |
3551 | <filename>kernel_configcheck</filename> task runs. | 3551 | <filename>do_kernel_configcheck</filename> task runs. |
3552 | This task validates the kernel configuration by checking the final | 3552 | This task validates the kernel configuration by checking the final |
3553 | <filename>.config</filename> file against the input files. | 3553 | <filename>.config</filename> file against the input files. |
3554 | During the check, the task produces warning messages for the following | 3554 | During the check, the task produces warning messages for the following |
@@ -3565,8 +3565,9 @@ | |||
3565 | In other words, the option does not appear anywhere.</para></listitem> | 3565 | In other words, the option does not appear anywhere.</para></listitem> |
3566 | </itemizedlist> | 3566 | </itemizedlist> |
3567 | <note> | 3567 | <note> |
3568 | The <filename>kernel_configcheck</filename> task can also optionally report | 3568 | The <filename>do_kernel_configcheck</filename> task can |
3569 | if an option is overridden during processing. | 3569 | also optionally report if an option is overridden during |
3570 | processing. | ||
3570 | </note> | 3571 | </note> |
3571 | </para> | 3572 | </para> |
3572 | 3573 | ||
@@ -3580,29 +3581,45 @@ | |||
3580 | <para> | 3581 | <para> |
3581 | To streamline the configuration, do the following: | 3582 | To streamline the configuration, do the following: |
3582 | <orderedlist> | 3583 | <orderedlist> |
3583 | <listitem><para>Start with a full configuration that you know | 3584 | <listitem><para>Start with a full configuration that you |
3584 | works - it builds and boots successfully. | 3585 | know works - it builds and boots successfully. |
3585 | This configuration file will be your baseline.</para></listitem> | 3586 | This configuration file will be your baseline. |
3586 | <listitem><para>Separately run the <filename>configme</filename> and | 3587 | </para></listitem> |
3587 | <filename>kernel_configcheck</filename> tasks.</para></listitem> | 3588 | <listitem><para>Separately run the |
3589 | <filename>do_configme</filename> and | ||
3590 | <filename>do_kernel_configcheck</filename> tasks. | ||
3591 | </para></listitem> | ||
3588 | <listitem><para>Take the resulting list of files from the | 3592 | <listitem><para>Take the resulting list of files from the |
3589 | <filename>kernel_configcheck</filename> task warnings and do the following: | 3593 | <filename>do_kernel_configcheck</filename> task |
3594 | warnings and do the following: | ||
3590 | <itemizedlist> | 3595 | <itemizedlist> |
3591 | <listitem><para>Drop values that are redefined in the fragment but do not | 3596 | <listitem><para> |
3592 | change the final <filename>.config</filename> file.</para></listitem> | 3597 | Drop values that are redefined in the fragment |
3593 | <listitem><para>Analyze and potentially drop values from the | 3598 | but do not change the final |
3594 | <filename>.config</filename> file that override required | 3599 | <filename>.config</filename> file. |
3595 | configurations.</para></listitem> | 3600 | </para></listitem> |
3596 | <listitem><para>Analyze and potentially remove non-board specific options. | 3601 | <listitem><para> |
3602 | Analyze and potentially drop values from the | ||
3603 | <filename>.config</filename> file that override | ||
3604 | required configurations. | ||
3605 | </para></listitem> | ||
3606 | <listitem><para> | ||
3607 | Analyze and potentially remove non-board | ||
3608 | specific options. | ||
3609 | </para></listitem> | ||
3610 | <listitem><para> | ||
3611 | Remove repeated and invalid options. | ||
3597 | </para></listitem> | 3612 | </para></listitem> |
3598 | <listitem><para>Remove repeated and invalid options.</para></listitem> | ||
3599 | </itemizedlist></para></listitem> | 3613 | </itemizedlist></para></listitem> |
3600 | <listitem><para>After you have worked through the output of the kernel configuration | 3614 | <listitem><para> |
3601 | audit, you can re-run the <filename>configme</filename> | 3615 | After you have worked through the output of the kernel |
3602 | and <filename>kernel_configcheck</filename> tasks to see the results of your | 3616 | configuration audit, you can re-run the |
3603 | changes. | 3617 | <filename>do_configme</filename> and |
3604 | If you have more issues, you can deal with them as described in the | 3618 | <filename>do_kernel_configcheck</filename> tasks to |
3605 | previous step.</para></listitem> | 3619 | see the results of your changes. |
3620 | If you have more issues, you can deal with them as | ||
3621 | described in the previous step. | ||
3622 | </para></listitem> | ||
3606 | </orderedlist> | 3623 | </orderedlist> |
3607 | </para> | 3624 | </para> |
3608 | 3625 | ||
@@ -5149,14 +5166,18 @@ Gateways via their Web Interfaces</ulink>"</emphasis> | |||
5149 | <section id="usingpoky-configuring-DISTRO_PN_ALIAS"> | 5166 | <section id="usingpoky-configuring-DISTRO_PN_ALIAS"> |
5150 | <title>Handling a Package Name Alias</title> | 5167 | <title>Handling a Package Name Alias</title> |
5151 | <para> | 5168 | <para> |
5152 | Sometimes a package name you are using might exist under an alias or as a similarly named | 5169 | Sometimes a package name you are using might exist under |
5153 | package in a different distribution. | 5170 | an alias or as a similarly named package in a different |
5154 | The OpenEmbedded build system implements a <filename>distro_check</filename> | 5171 | distribution. |
5172 | The OpenEmbedded build system implements a | ||
5173 | <filename>do_distro_check</filename> | ||
5155 | task that automatically connects to major distributions | 5174 | task that automatically connects to major distributions |
5156 | and checks for these situations. | 5175 | and checks for these situations. |
5157 | If the package exists under a different name in a different distribution, you get a | 5176 | If the package exists under a different name in a different |
5158 | <filename>distro_check</filename> mismatch. | 5177 | distribution, you get a <filename>distro_check</filename> |
5159 | You can resolve this problem by defining a per-distro recipe name alias using the | 5178 | mismatch. |
5179 | You can resolve this problem by defining a per-distro recipe | ||
5180 | name alias using the | ||
5160 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename> | 5181 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename> |
5161 | variable. | 5182 | variable. |
5162 | </para> | 5183 | </para> |
@@ -6922,7 +6943,7 @@ Gateways via their Web Interfaces</ulink>"</emphasis> | |||
6922 | Returns "True" if <filename>pkg</filename> is in the | 6943 | Returns "True" if <filename>pkg</filename> is in the |
6923 | installed package list of the image, which is based | 6944 | installed package list of the image, which is based |
6924 | on the manifest file that is generated during the | 6945 | on the manifest file that is generated during the |
6925 | <filename>do.rootfs</filename> task. | 6946 | <filename>do_rootfs</filename> task. |
6926 | </para></listitem> | 6947 | </para></listitem> |
6927 | <listitem><para><emphasis><filename>hasFeature(feature)</filename>:</emphasis> | 6948 | <listitem><para><emphasis><filename>hasFeature(feature)</filename>:</emphasis> |
6928 | Returns "True" if the feature is in | 6949 | Returns "True" if the feature is in |
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 4fd4c4e1e3..59e19a2bae 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
@@ -1773,8 +1773,10 @@ | |||
1773 | Make your changes in the temporary source code to the files you added | 1773 | Make your changes in the temporary source code to the files you added |
1774 | to the patch.</para></listitem> | 1774 | to the patch.</para></listitem> |
1775 | <listitem><para><emphasis>Test Your Changes:</emphasis> | 1775 | <listitem><para><emphasis>Test Your Changes:</emphasis> |
1776 | Once you have modified the source code, the easiest way to test your changes | 1776 | Once you have modified the source code, the easiest way to |
1777 | is by calling the <filename>compile</filename> task as shown in the following example: | 1777 | your changes is by calling the |
1778 | <filename>do_compile</filename> task as shown in the | ||
1779 | following example: | ||
1778 | <literallayout class='monospaced'> | 1780 | <literallayout class='monospaced'> |
1779 | $ bitbake -c compile -f <name_of_package> | 1781 | $ bitbake -c compile -f <name_of_package> |
1780 | </literallayout> | 1782 | </literallayout> |
@@ -1870,8 +1872,10 @@ | |||
1870 | <listitem><para><emphasis>Edit the Files:</emphasis> | 1872 | <listitem><para><emphasis>Edit the Files:</emphasis> |
1871 | Make your changes to the temporary source code.</para></listitem> | 1873 | Make your changes to the temporary source code.</para></listitem> |
1872 | <listitem><para><emphasis>Test Your Changes:</emphasis> | 1874 | <listitem><para><emphasis>Test Your Changes:</emphasis> |
1873 | Once you have modified the source code, the easiest way to test your changes | 1875 | Once you have modified the source code, the easiest way |
1874 | is by calling the <filename>compile</filename> task as shown in the following example: | 1876 | to test your changes is by calling the |
1877 | <filename>do_compile</filename> task as shown in the | ||
1878 | following example: | ||
1875 | <literallayout class='monospaced'> | 1879 | <literallayout class='monospaced'> |
1876 | $ bitbake -c compile -f <name_of_package> | 1880 | $ bitbake -c compile -f <name_of_package> |
1877 | </literallayout> | 1881 | </literallayout> |
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index b3f4c438d7..31ffa5c83c 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml | |||
@@ -445,7 +445,7 @@ | |||
445 | You can edit the sources as you would any other Linux source | 445 | You can edit the sources as you would any other Linux source |
446 | tree. | 446 | tree. |
447 | However, keep in mind that you will lose changes if you | 447 | However, keep in mind that you will lose changes if you |
448 | trigger the <filename>fetch</filename> task for the recipe. | 448 | trigger the <filename>do_fetch</filename> task for the recipe. |
449 | You can avoid triggering this task by not issuing BitBake's | 449 | You can avoid triggering this task by not issuing BitBake's |
450 | <filename>cleanall</filename>, <filename>cleansstate</filename>, | 450 | <filename>cleanall</filename>, <filename>cleansstate</filename>, |
451 | or forced <filename>fetch</filename> commands. | 451 | or forced <filename>fetch</filename> commands. |
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 3653edd916..e7e9942b3b 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -569,7 +569,7 @@ | |||
569 | 569 | ||
570 | <para> | 570 | <para> |
571 | The <filename>devshell</filename> class adds the | 571 | The <filename>devshell</filename> class adds the |
572 | <filename>devshell</filename> task. | 572 | <filename>do_devshell</filename> task. |
573 | Distribution policy dictates whether to include this class. | 573 | Distribution policy dictates whether to include this class. |
574 | See the | 574 | See the |
575 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section | 575 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section |
@@ -606,8 +606,8 @@ | |||
606 | provides for automatic checking for upstream recipe updates. | 606 | provides for automatic checking for upstream recipe updates. |
607 | The class creates a comma-separated value (CSV) spreadsheet that | 607 | The class creates a comma-separated value (CSV) spreadsheet that |
608 | contains information about the recipes. | 608 | contains information about the recipes. |
609 | The information provides the <filename>distrodata</filename> and | 609 | The information provides the <filename>do_distrodata</filename> and |
610 | <filename>distro_check</filename> tasks, which do upstream checking | 610 | <filename>do_distro_check</filename> tasks, which do upstream checking |
611 | and also verify if a package is used in multiple major distributions. | 611 | and also verify if a package is used in multiple major distributions. |
612 | </para> | 612 | </para> |
613 | 613 | ||
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index c849dbda33..389e75ad97 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
@@ -800,8 +800,9 @@ | |||
800 | <para> | 800 | <para> |
801 | This directory contains general logs that are not otherwise placed using the | 801 | This directory contains general logs that are not otherwise placed using the |
802 | package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>. | 802 | package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>. |
803 | Examples of logs are the output from the <filename>check_pkg</filename> or | 803 | Examples of logs are the output from the |
804 | <filename>distro_check</filename> tasks. | 804 | <filename>do_check_pkg</filename> or |
805 | <filename>do_distro_check</filename> tasks. | ||
805 | Running a build does not necessarily mean this directory is created. | 806 | Running a build does not necessarily mean this directory is created. |
806 | </para> | 807 | </para> |
807 | </section> | 808 | </section> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 518dc2e3f6..6fae9f735e 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -7796,7 +7796,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
7796 | Instead, files should be installed to | 7796 | Instead, files should be installed to |
7797 | <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> | 7797 | <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> |
7798 | within your recipe's | 7798 | within your recipe's |
7799 | <link linkend='ref-tasks-install'><filename>install</filename></link> | 7799 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> |
7800 | task and then the OpenEmbedded build system will | 7800 | task and then the OpenEmbedded build system will |
7801 | stage a subset of those files into the sysroot. | 7801 | stage a subset of those files into the sysroot. |
7802 | </note> | 7802 | </note> |
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 319795f672..ee08831c42 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
@@ -442,11 +442,11 @@ | |||
442 | works on a per-task basis rather than a per-recipe basis. | 442 | works on a per-task basis rather than a per-recipe basis. |
443 | You might wonder why using a per-task basis is preferred over a per-recipe basis. | 443 | You might wonder why using a per-task basis is preferred over a per-recipe basis. |
444 | To help explain, consider having the IPK packaging backend enabled and then switching to DEB. | 444 | To help explain, consider having the IPK packaging backend enabled and then switching to DEB. |
445 | In this case, | 445 | In this case, the |
446 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> | 446 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> |
447 | and | 447 | and |
448 | <link linkend='ref-tasks-package'><filename>do_package</filename></link> | 448 | <link linkend='ref-tasks-package'><filename>do_package</filename></link> |
449 | outputs are still valid. | 449 | task outputs are still valid. |
450 | However, with a per-recipe approach, the build would not include the | 450 | However, with a per-recipe approach, the build would not include the |
451 | <filename>.deb</filename> files. | 451 | <filename>.deb</filename> files. |
452 | Consequently, you would have to invalidate the whole build and rerun it. | 452 | Consequently, you would have to invalidate the whole build and rerun it. |
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 3748ac21bb..3c82d8185b 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml | |||
@@ -173,17 +173,20 @@ | |||
173 | 173 | ||
174 | <para> | 174 | <para> |
175 | Any given package consists of a set of tasks. | 175 | Any given package consists of a set of tasks. |
176 | The standard BitBake behavior in most cases is: <filename>fetch</filename>, | 176 | The standard BitBake behavior in most cases is: |
177 | <filename>unpack</filename>, | 177 | <filename>do_fetch</filename>, |
178 | <filename>patch</filename>, <filename>configure</filename>, | 178 | <filename>do_unpack</filename>, |
179 | <filename>compile</filename>, <filename>install</filename>, <filename>package</filename>, | 179 | <filename>do_patch</filename>, <filename>do_configure</filename>, |
180 | <filename>package_write</filename>, and <filename>build</filename>. | 180 | <filename>do_compile</filename>, <filename>do_install</filename>, |
181 | The default task is <filename>build</filename> and any tasks on which it depends | 181 | <filename>do_package</filename>, |
182 | build first. | 182 | <filename>do_package_write</filename>, and |
183 | Some tasks, such as <filename>devshell</filename>, are not part of the | 183 | <filename>do_build</filename>. |
184 | default build chain. | 184 | The default task is <filename>do_build</filename> and any tasks |
185 | If you wish to run a task that is not part of the default build chain, you can use the | 185 | on which it depends build first. |
186 | <filename>-c</filename> option in BitBake. | 186 | Some tasks, such as <filename>do_devshell</filename>, are not part |
187 | of the default build chain. | ||
188 | If you wish to run a task that is not part of the default build | ||
189 | chain, you can use the <filename>-c</filename> option in BitBake. | ||
187 | Here is an example: | 190 | Here is an example: |
188 | <literallayout class='monospaced'> | 191 | <literallayout class='monospaced'> |
189 | $ bitbake matchbox-desktop -c devshell | 192 | $ bitbake matchbox-desktop -c devshell |
@@ -210,14 +213,16 @@ | |||
210 | <para> | 213 | <para> |
211 | This sequence first builds and then recompiles | 214 | This sequence first builds and then recompiles |
212 | <filename>matchbox-desktop</filename>. | 215 | <filename>matchbox-desktop</filename>. |
213 | The last command reruns all tasks (basically the packaging tasks) after the compile. | 216 | The last command reruns all tasks (basically the packaging tasks) |
214 | BitBake recognizes that the <filename>compile</filename> task was rerun and therefore | 217 | after the compile. |
215 | understands that the other tasks also need to be run again. | 218 | BitBake recognizes that the <filename>do_compile</filename> |
219 | task was rerun and therefore understands that the other tasks | ||
220 | also need to be run again. | ||
216 | </para> | 221 | </para> |
217 | 222 | ||
218 | <para> | 223 | <para> |
219 | You can view a list of tasks in a given package by running the | 224 | You can view a list of tasks in a given package by running the |
220 | <filename>listtasks</filename> task as follows: | 225 | <filename>do_listtasks</filename> task as follows: |
221 | <literallayout class='monospaced'> | 226 | <literallayout class='monospaced'> |
222 | $ bitbake matchbox-desktop -c listtasks | 227 | $ bitbake matchbox-desktop -c listtasks |
223 | </literallayout> | 228 | </literallayout> |