diff options
| -rw-r--r-- | documentation/ref-manual/ref-tasks.xml | 131 |
1 files changed, 98 insertions, 33 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 8f62da02f0..5bff93b1c5 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml | |||
| @@ -25,8 +25,9 @@ | |||
| 25 | <title><filename>do_build</filename></title> | 25 | <title><filename>do_build</filename></title> |
| 26 | 26 | ||
| 27 | <para> | 27 | <para> |
| 28 | Default task for a recipe - depends on all other normal tasks | 28 | The default task for all recipes. |
| 29 | required to 'build' a recipe. | 29 | This task depends on all other normal tasks |
| 30 | required to build a recipe. | ||
| 30 | </para> | 31 | </para> |
| 31 | </section> | 32 | </section> |
| 32 | 33 | ||
| @@ -34,7 +35,9 @@ | |||
| 34 | <title><filename>do_compile</filename></title> | 35 | <title><filename>do_compile</filename></title> |
| 35 | 36 | ||
| 36 | <para> | 37 | <para> |
| 37 | Compiles the source in the compilation directory. | 38 | Compiles the source in the compilation directory, which is pointed |
| 39 | to by the | ||
| 40 | <link linkend='var-B'><filename>B</filename></link> variable. | ||
| 38 | </para> | 41 | </para> |
| 39 | </section> | 42 | </section> |
| 40 | 43 | ||
| @@ -69,7 +72,10 @@ | |||
| 69 | <title><filename>do_deploy</filename></title> | 72 | <title><filename>do_deploy</filename></title> |
| 70 | 73 | ||
| 71 | <para> | 74 | <para> |
| 72 | Writes deployable output files to the deploy directory. | 75 | Writes output files that are to be deployed to the deploy |
| 76 | directory, which is defined by the | ||
| 77 | <link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link> | ||
| 78 | variable. | ||
| 73 | </para> | 79 | </para> |
| 74 | </section> | 80 | </section> |
| 75 | 81 | ||
| @@ -78,6 +84,12 @@ | |||
| 78 | 84 | ||
| 79 | <para> | 85 | <para> |
| 80 | Fetches the source code. | 86 | Fetches the source code. |
| 87 | This task uses the | ||
| 88 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> | ||
| 89 | variable and the argument's prefix to determine the correct | ||
| 90 | fetcher module. | ||
| 91 | Unpacked source files reside in the | ||
| 92 | <link linkend='var-S'><filename>S</filename></link> directory. | ||
| 81 | </para> | 93 | </para> |
| 82 | </section> | 94 | </section> |
| 83 | 95 | ||
| @@ -85,7 +97,11 @@ | |||
| 85 | <title><filename>do_install</filename></title> | 97 | <title><filename>do_install</filename></title> |
| 86 | 98 | ||
| 87 | <para> | 99 | <para> |
| 88 | Copies files from the compilation directory to a holding area. | 100 | Copies files from the compilation directory, which is defined by |
| 101 | the | ||
| 102 | <link linkend='var-B'><filename>B</filename></link> variable, | ||
| 103 | to a holding area defined by the | ||
| 104 | <link linkend='var-D'><filename>D</filename></link> variable. | ||
| 89 | </para> | 105 | </para> |
| 90 | </section> | 106 | </section> |
| 91 | 107 | ||
| @@ -111,7 +127,9 @@ | |||
| 111 | <title><filename>do_package_index</filename></title> | 127 | <title><filename>do_package_index</filename></title> |
| 112 | 128 | ||
| 113 | <para> | 129 | <para> |
| 114 | Creates or updates the index in the Package Feed area. | 130 | Creates or updates the index in the |
| 131 | <link linkend='package-feeds-dev-environment'>Package Feeds</link> | ||
| 132 | area. | ||
| 115 | </para> | 133 | </para> |
| 116 | </section> | 134 | </section> |
| 117 | 135 | ||
| @@ -119,7 +137,8 @@ | |||
| 119 | <title><filename>do_package_write_deb</filename></title> | 137 | <title><filename>do_package_write_deb</filename></title> |
| 120 | 138 | ||
| 121 | <para> | 139 | <para> |
| 122 | Creates the actual DEB packages and places them in the Package Feed | 140 | Creates the actual DEB packages and places them in the |
| 141 | <link linkend='package-feeds-dev-environment'>Package Feeds</link> | ||
| 123 | area. | 142 | area. |
| 124 | </para> | 143 | </para> |
| 125 | </section> | 144 | </section> |
| @@ -128,7 +147,8 @@ | |||
| 128 | <title><filename>do_package_write_ipk</filename></title> | 147 | <title><filename>do_package_write_ipk</filename></title> |
| 129 | 148 | ||
| 130 | <para> | 149 | <para> |
| 131 | Creates the actual IPK packages and places them in the Package Feed | 150 | Creates the actual IPK packages and places them in the |
| 151 | <link linkend='package-feeds-dev-environment'>Package Feeds</link> | ||
| 132 | area. | 152 | area. |
| 133 | </para> | 153 | </para> |
| 134 | </section> | 154 | </section> |
| @@ -137,7 +157,8 @@ | |||
| 137 | <title><filename>do_package_write_rpm</filename></title> | 157 | <title><filename>do_package_write_rpm</filename></title> |
| 138 | 158 | ||
| 139 | <para> | 159 | <para> |
| 140 | Creates the actual RPM packages and places them in the Package Feed | 160 | Creates the actual RPM packages and places them in the |
| 161 | <link linkend='package-feeds-dev-environment'>Package Feeds</link> | ||
| 141 | area. | 162 | area. |
| 142 | </para> | 163 | </para> |
| 143 | </section> | 164 | </section> |
| @@ -146,8 +167,9 @@ | |||
| 146 | <title><filename>do_package_write_tar</filename></title> | 167 | <title><filename>do_package_write_tar</filename></title> |
| 147 | 168 | ||
| 148 | <para> | 169 | <para> |
| 149 | Creates tar archives for packages and places them in the Package | 170 | Creates tar archives for packages and places them in the |
| 150 | Feed area. | 171 | <link linkend='package-feeds-dev-environment'>Package Feeds</link> |
| 172 | area. | ||
| 151 | </para> | 173 | </para> |
| 152 | </section> | 174 | </section> |
| 153 | 175 | ||
| @@ -165,6 +187,9 @@ | |||
| 165 | 187 | ||
| 166 | <para> | 188 | <para> |
| 167 | Locates patch files and applies them to the source code. | 189 | Locates patch files and applies them to the source code. |
| 190 | See the | ||
| 191 | "<link linkend='patching-dev-environment'>Patching</link>" | ||
| 192 | section for more information. | ||
| 168 | </para> | 193 | </para> |
| 169 | </section> | 194 | </section> |
| 170 | 195 | ||
| @@ -182,6 +207,9 @@ | |||
| 182 | 207 | ||
| 183 | <para> | 208 | <para> |
| 184 | Creates the file and directory structure for an installable SDK. | 209 | Creates the file and directory structure for an installable SDK. |
| 210 | See the | ||
| 211 | "<link linkend='sdk-generation-dev-environment'>SDK Generation</link>" | ||
| 212 | section for more information. | ||
| 185 | </para> | 213 | </para> |
| 186 | </section> | 214 | </section> |
| 187 | 215 | ||
| @@ -200,7 +228,11 @@ | |||
| 200 | <title><filename>do_rm_work</filename></title> | 228 | <title><filename>do_rm_work</filename></title> |
| 201 | 229 | ||
| 202 | <para> | 230 | <para> |
| 203 | Removes work files after the build system has finished with them. | 231 | Removes work files after the OpenEmbedded build system has |
| 232 | finished with them. | ||
| 233 | You can learn more by looking at the | ||
| 234 | "<link linkend='ref-classes-rm-work'><filename>rm_work.bbclass</filename></link>" | ||
| 235 | section. | ||
| 204 | </para> | 236 | </para> |
| 205 | </section> | 237 | </section> |
| 206 | 238 | ||
| @@ -218,6 +250,9 @@ | |||
| 218 | 250 | ||
| 219 | <para> | 251 | <para> |
| 220 | Unpacks the source code into a working directory. | 252 | Unpacks the source code into a working directory. |
| 253 | For more information on fetching and unpacking source files, see the | ||
| 254 | "<link linkend='source-fetching-dev-environment'>Source Fetching</link>" | ||
| 255 | section. | ||
| 221 | </para> | 256 | </para> |
| 222 | </section> | 257 | </section> |
| 223 | </section> | 258 | </section> |
| @@ -234,7 +269,9 @@ | |||
| 234 | <title><filename>do_checkuri</filename></title> | 269 | <title><filename>do_checkuri</filename></title> |
| 235 | 270 | ||
| 236 | <para> | 271 | <para> |
| 237 | Validates the SRC_URI value. | 272 | Validates the |
| 273 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> | ||
| 274 | value. | ||
| 238 | </para> | 275 | </para> |
| 239 | </section> | 276 | </section> |
| 240 | 277 | ||
| @@ -242,8 +279,9 @@ | |||
| 242 | <title><filename>do_checkuriall</filename></title> | 279 | <title><filename>do_checkuriall</filename></title> |
| 243 | 280 | ||
| 244 | <para> | 281 | <para> |
| 245 | Validates the SRC_URI value for all recipes required to build a | 282 | Validates the |
| 246 | target. | 283 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> |
| 284 | value for all recipes required to build a target. | ||
| 247 | </para> | 285 | </para> |
| 248 | </section> | 286 | </section> |
| 249 | 287 | ||
| @@ -259,8 +297,9 @@ | |||
| 259 | <title><filename>do_cleanall</filename></title> | 297 | <title><filename>do_cleanall</filename></title> |
| 260 | 298 | ||
| 261 | <para> | 299 | <para> |
| 262 | Removes all output files, shared state cache, and downloaded source | 300 | Removes all output files, shared state |
| 263 | files for a target. | 301 | (<link linkend='shared-state-cache'>sstate</link>) cache, and |
| 302 | downloaded source files for a target. | ||
| 264 | </para> | 303 | </para> |
| 265 | </section> | 304 | </section> |
| 266 | 305 | ||
| @@ -268,7 +307,9 @@ | |||
| 268 | <title><filename>do_cleansstate</filename></title> | 307 | <title><filename>do_cleansstate</filename></title> |
| 269 | 308 | ||
| 270 | <para> | 309 | <para> |
| 271 | Removes all output files and shared state cache for a target. | 310 | Removes all output files and shared state |
| 311 | (<link linkend='shared-state-cache'>sstate</link>) | ||
| 312 | cache for a target. | ||
| 272 | </para> | 313 | </para> |
| 273 | </section> | 314 | </section> |
| 274 | 315 | ||
| @@ -284,8 +325,12 @@ | |||
| 284 | <title><filename>do_devshell</filename></title> | 325 | <title><filename>do_devshell</filename></title> |
| 285 | 326 | ||
| 286 | <para> | 327 | <para> |
| 287 | Starts a shell with the environment set up for | 328 | Starts a shell whose environment is set up for |
| 288 | development/debugging. | 329 | development, debugging, or both. |
| 330 | See the | ||
| 331 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" | ||
| 332 | section in the Yocto Project Development Manual for more | ||
| 333 | information about using <filename>devshell</filename>. | ||
| 289 | </para> | 334 | </para> |
| 290 | </section> | 335 | </section> |
| 291 | 336 | ||
| @@ -310,6 +355,9 @@ | |||
| 310 | 355 | ||
| 311 | <para> | 356 | <para> |
| 312 | Creates a bootable live image. | 357 | Creates a bootable live image. |
| 358 | See the | ||
| 359 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> | ||
| 360 | variable for additional information on live image types. | ||
| 313 | </para> | 361 | </para> |
| 314 | </section> | 362 | </section> |
| 315 | 363 | ||
| @@ -317,8 +365,11 @@ | |||
| 317 | <title><filename>do_bundle_initramfs</filename></title> | 365 | <title><filename>do_bundle_initramfs</filename></title> |
| 318 | 366 | ||
| 319 | <para> | 367 | <para> |
| 320 | Combines an initial ramdisk image and kernel together to form | 368 | Combines an initial RAM disk (initramfs) image and kernel |
| 321 | a single image. | 369 | together to form a single image. |
| 370 | The | ||
| 371 | <link linkend='var-CONFIG_INITRAMFS_SOURCE'><filename>CONFIG_INITRAMFS_SOURCE</filename></link> | ||
| 372 | variable has some more information about these types of images. | ||
| 322 | </para> | 373 | </para> |
| 323 | </section> | 374 | </section> |
| 324 | 375 | ||
| @@ -328,6 +379,9 @@ | |||
| 328 | <para> | 379 | <para> |
| 329 | Creates the root filesystem (file and directory structure) for an | 380 | Creates the root filesystem (file and directory structure) for an |
| 330 | image. | 381 | image. |
| 382 | See the | ||
| 383 | "<link linkend='image-generation-dev-environment'>Image Generation</link>" | ||
| 384 | section for more information on how the root filesystem is created. | ||
| 331 | </para> | 385 | </para> |
| 332 | </section> | 386 | </section> |
| 333 | 387 | ||
| @@ -352,8 +406,9 @@ | |||
| 352 | <title><filename>do_vmdkimg</filename></title> | 406 | <title><filename>do_vmdkimg</filename></title> |
| 353 | 407 | ||
| 354 | <para> | 408 | <para> |
| 355 | Creates a .vmdk image for use with VMware and compatible virtual | 409 | Creates a <filename>.vmdk</filename> image for use with |
| 356 | machine hosts. | 410 | <ulink url='http://www.vmware.com/'>VMware</ulink> |
| 411 | and compatible virtual machine hosts. | ||
| 357 | </para> | 412 | </para> |
| 358 | </section> | 413 | </section> |
| 359 | </section> | 414 | </section> |
| @@ -363,10 +418,10 @@ | |||
| 363 | 418 | ||
| 364 | <para> | 419 | <para> |
| 365 | The following tasks are applicable to kernel recipes. | 420 | The following tasks are applicable to kernel recipes. |
| 366 | Some of them (e.g. the | 421 | Some of these tasks (e.g. the |
| 367 | <link linkend='ref-tasks-menuconfig'><filename>do_menuconfig</filename></link> | 422 | <link linkend='ref-tasks-menuconfig'><filename>do_menuconfig</filename></link> |
| 368 | task) are also applicable to recipes that use | 423 | task) are also applicable to recipes that use |
| 369 | Linux kernel style configuration (e.g. BusyBox). | 424 | Linux kernel style configuration such as the BusyBox recipe. |
| 370 | </para> | 425 | </para> |
| 371 | 426 | ||
| 372 | <section id='ref-tasks-compile_kernelmodules'> | 427 | <section id='ref-tasks-compile_kernelmodules'> |
| @@ -415,7 +470,8 @@ | |||
| 415 | <title><filename>do_kernel_link_vmlinux</filename></title> | 470 | <title><filename>do_kernel_link_vmlinux</filename></title> |
| 416 | 471 | ||
| 417 | <para> | 472 | <para> |
| 418 | Creates a symbolic link in arch/$arch/boot for vmlinux kernel | 473 | Creates a symbolic link in |
| 474 | <filename>arch/$arch/boot</filename> for vmlinux kernel | ||
| 419 | images. | 475 | images. |
| 420 | </para> | 476 | </para> |
| 421 | </section> | 477 | </section> |
| @@ -424,7 +480,10 @@ | |||
| 424 | <title><filename>do_menuconfig</filename></title> | 480 | <title><filename>do_menuconfig</filename></title> |
| 425 | 481 | ||
| 426 | <para> | 482 | <para> |
| 427 | Runs 'make menuconfig' for the kernel. | 483 | Runs <filename>make menuconfig</filename> for the kernel. |
| 484 | For information on <filename>menuconfig</filename>, see the | ||
| 485 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-menuconfig'>Using <filename>menuconfig</filename></ulink>" | ||
| 486 | section in the Yocto Project Development Manual. | ||
| 428 | </para> | 487 | </para> |
| 429 | </section> | 488 | </section> |
| 430 | 489 | ||
| @@ -440,8 +499,8 @@ | |||
| 440 | <title><filename>do_sizecheck</filename></title> | 499 | <title><filename>do_sizecheck</filename></title> |
| 441 | 500 | ||
| 442 | <para> | 501 | <para> |
| 443 | Checks the size of the kernel image against KERNEL_IMAGE_MAXSIZE | 502 | Checks the size of the kernel image against |
| 444 | (if set). | 503 | <filename>KERNEL_IMAGE_MAXSIZE</filename> when set. |
| 445 | </para> | 504 | </para> |
| 446 | </section> | 505 | </section> |
| 447 | 506 | ||
| @@ -465,8 +524,10 @@ | |||
| 465 | <title><filename>do_validate_branches</filename></title> | 524 | <title><filename>do_validate_branches</filename></title> |
| 466 | 525 | ||
| 467 | <para> | 526 | <para> |
| 468 | Ensures that the source/meta branches are on the locations | 527 | Ensures that the source, metadata (or both) branches are on the |
| 469 | specified by their SRCREV values for a linux-yocto style kernel. | 528 | locations specified by their |
| 529 | <link linkend='var-SRCREV'><filename>SRCREV</filename></link> | ||
| 530 | values for a linux-yocto style kernel. | ||
| 470 | </para> | 531 | </para> |
| 471 | </section> | 532 | </section> |
| 472 | </section> | 533 | </section> |
| @@ -482,7 +543,8 @@ | |||
| 482 | <title><filename>do_generate_qt_config_file</filename></title> | 543 | <title><filename>do_generate_qt_config_file</filename></title> |
| 483 | 544 | ||
| 484 | <para> | 545 | <para> |
| 485 | Writes a qt.conf file for building a Qt-based application. | 546 | Writes a <filename>qt.conf</filename> configuration |
| 547 | file used for building a Qt-based application. | ||
| 486 | </para> | 548 | </para> |
| 487 | </section> | 549 | </section> |
| 488 | 550 | ||
| @@ -492,6 +554,9 @@ | |||
| 492 | <para> | 554 | <para> |
| 493 | A build stage that takes the source code and scans it on a remote | 555 | A build stage that takes the source code and scans it on a remote |
| 494 | FOSSOLOGY server in order to produce an SPDX document. | 556 | FOSSOLOGY server in order to produce an SPDX document. |
| 557 | This task applies only to the | ||
| 558 | <link linkend='ref-classes-spdx'><filename>spdx</filename></link> | ||
| 559 | class. | ||
| 495 | </para> | 560 | </para> |
| 496 | </section> | 561 | </section> |
| 497 | </section> | 562 | </section> |
