diff options
Diffstat (limited to 'documentation/ref-manual')
-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 |
5 files changed, 29 insertions, 23 deletions
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> |