From a19f575cde39917e4632dab1e813d84402f95937 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 11 Jun 2014 10:46:05 +0300 Subject: 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_". Some occurrences did not include the "do_" prefix. These have been fixed. (From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 79 ++++++++++++++-------- documentation/dev-manual/dev-manual-model.xml | 12 ++-- documentation/kernel-dev/kernel-dev-common.xml | 2 +- documentation/ref-manual/ref-classes.xml | 6 +- documentation/ref-manual/ref-structure.xml | 5 +- documentation/ref-manual/ref-variables.xml | 2 +- documentation/ref-manual/technical-details.xml | 4 +- 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 @@ As part of the kernel build process, the - kernel_configcheck task runs. + do_kernel_configcheck task runs. This task validates the kernel configuration by checking the final .config file against the input files. During the check, the task produces warning messages for the following @@ -3565,8 +3565,9 @@ In other words, the option does not appear anywhere. - The kernel_configcheck task can also optionally report - if an option is overridden during processing. + The do_kernel_configcheck task can + also optionally report if an option is overridden during + processing. @@ -3580,29 +3581,45 @@ To streamline the configuration, do the following: - Start with a full configuration that you know - works - it builds and boots successfully. - This configuration file will be your baseline. - Separately run the configme and - kernel_configcheck tasks. + Start with a full configuration that you + know works - it builds and boots successfully. + This configuration file will be your baseline. + + Separately run the + do_configme and + do_kernel_configcheck tasks. + Take the resulting list of files from the - kernel_configcheck task warnings and do the following: + do_kernel_configcheck task + warnings and do the following: - Drop values that are redefined in the fragment but do not - change the final .config file. - Analyze and potentially drop values from the - .config file that override required - configurations. - Analyze and potentially remove non-board specific options. + + Drop values that are redefined in the fragment + but do not change the final + .config file. + + + Analyze and potentially drop values from the + .config file that override + required configurations. + + + Analyze and potentially remove non-board + specific options. + + + Remove repeated and invalid options. - Remove repeated and invalid options. - After you have worked through the output of the kernel configuration - audit, you can re-run the configme - and kernel_configcheck tasks to see the results of your - changes. - If you have more issues, you can deal with them as described in the - previous step. + + After you have worked through the output of the kernel + configuration audit, you can re-run the + do_configme and + do_kernel_configcheck tasks to + see the results of your changes. + If you have more issues, you can deal with them as + described in the previous step. + @@ -5149,14 +5166,18 @@ Gateways via their Web Interfaces"
Handling a Package Name Alias - Sometimes a package name you are using might exist under an alias or as a similarly named - package in a different distribution. - The OpenEmbedded build system implements a distro_check + Sometimes a package name you are using might exist under + an alias or as a similarly named package in a different + distribution. + The OpenEmbedded build system implements a + do_distro_check task that automatically connects to major distributions and checks for these situations. - If the package exists under a different name in a different distribution, you get a - distro_check mismatch. - You can resolve this problem by defining a per-distro recipe name alias using the + If the package exists under a different name in a different + distribution, you get a distro_check + mismatch. + You can resolve this problem by defining a per-distro recipe + name alias using the DISTRO_PN_ALIAS variable. @@ -6922,7 +6943,7 @@ Gateways via their Web Interfaces" Returns "True" if pkg is in the installed package list of the image, which is based on the manifest file that is generated during the - do.rootfs task. + do_rootfs task. hasFeature(feature): 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 @@ Make your changes in the temporary source code to the files you added to the patch. Test Your Changes: - Once you have modified the source code, the easiest way to test your changes - is by calling the compile task as shown in the following example: + Once you have modified the source code, the easiest way to + your changes is by calling the + do_compile task as shown in the + following example: $ bitbake -c compile -f <name_of_package> @@ -1870,8 +1872,10 @@ Edit the Files: Make your changes to the temporary source code. Test Your Changes: - Once you have modified the source code, the easiest way to test your changes - is by calling the compile task as shown in the following example: + Once you have modified the source code, the easiest way + to test your changes is by calling the + do_compile task as shown in the + following example: $ bitbake -c compile -f <name_of_package> 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 @@ You can edit the sources as you would any other Linux source tree. However, keep in mind that you will lose changes if you - trigger the fetch task for the recipe. + trigger the do_fetch task for the recipe. You can avoid triggering this task by not issuing BitBake's cleanall, cleansstate, or forced fetch 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 @@ The devshell class adds the - devshell task. + do_devshell task. Distribution policy dictates whether to include this class. See the "Using a Development Shell" 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 distrodata and - distro_check tasks, which do upstream checking + The information provides the do_distrodata and + do_distro_check tasks, which do upstream checking and also verify if a package is used in multiple major distributions. 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 @@ This directory contains general logs that are not otherwise placed using the package's WORKDIR. - Examples of logs are the output from the check_pkg or - distro_check tasks. + Examples of logs are the output from the + do_check_pkg or + do_distro_check tasks. Running a build does not necessarily mean this directory is created.
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" Instead, files should be installed to ${D} within your recipe's - install + do_install task and then the OpenEmbedded build system will stage a subset of those files into the sysroot. 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 @@ 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 do_install and do_package - outputs are still valid. + task outputs are still valid. However, with a per-recipe approach, the build would not include the .deb files. 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 @@ Any given package consists of a set of tasks. - The standard BitBake behavior in most cases is: fetch, - unpack, - patch, configure, - compile, install, package, - package_write, and build. - The default task is build and any tasks on which it depends - build first. - Some tasks, such as devshell, 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 - -c option in BitBake. + The standard BitBake behavior in most cases is: + do_fetch, + do_unpack, + do_patch, do_configure, + do_compile, do_install, + do_package, + do_package_write, and + do_build. + The default task is do_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 wish to run a task that is not part of the default build + chain, you can use the -c option in BitBake. Here is an example: $ bitbake matchbox-desktop -c devshell @@ -210,14 +213,16 @@ 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 compile 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 do_compile + task was rerun and therefore understands that the other tasks + also need to be run again. You can view a list of tasks in a given package by running the - listtasks task as follows: + do_listtasks task as follows: $ bitbake matchbox-desktop -c listtasks -- cgit v1.2.3-54-g00ecf