diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2018-02-02 10:11:58 -0800 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-02-14 15:25:31 +0000 |
| commit | 813772451fe9045e78b94015950aa26380e46440 (patch) | |
| tree | 9e2a888df23e4e2bb494c7cd65c87b159aa036f1 /documentation/ref-manual | |
| parent | b509d336c757300b1fc9312f755b3bfd8707bf79 (diff) | |
| download | poky-813772451fe9045e78b94015950aa26380e46440.tar.gz | |
documentation: Moved the detailed build section to concepts-manual.
The section that provides a closer look into the build system has
moved from the getting-started manaul to the concepts-manual.
I fixed all the links, provided some coded formatting of the
entire section, and made general updates.
The other manuals had links that needed fixed due to the move.
(From yocto-docs rev: b83a5619f56ebd9879fdcadcf474859e68b26d58)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/ref-classes.xml | 8 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-structure.xml | 10 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-tasks.xml | 42 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 43 |
4 files changed, 50 insertions, 53 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index ff13213fad..8dfa0851cd 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
| @@ -1251,8 +1251,8 @@ | |||
| 1251 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>" | 1251 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>" |
| 1252 | section in the Yocto Project Development Tasks Manual. | 1252 | section in the Yocto Project Development Tasks Manual. |
| 1253 | For information on how images are created, see the | 1253 | For information on how images are created, see the |
| 1254 | "<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>" | 1254 | "<ulink url='&YOCTO_DOCS_CM_URL;#images-dev-environment'>Images</ulink>" |
| 1255 | section in the Getting Started With Yocto Project Manual. | 1255 | section in the Yocto Project Concpets Manual. |
| 1256 | </para> | 1256 | </para> |
| 1257 | </section> | 1257 | </section> |
| 1258 | 1258 | ||
| @@ -3020,8 +3020,8 @@ This check was removed for YP 2.3 release | |||
| 3020 | 3020 | ||
| 3021 | <para> | 3021 | <para> |
| 3022 | For information on how root filesystem images are created, see the | 3022 | For information on how root filesystem images are created, see the |
| 3023 | "<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>" | 3023 | "<ulink url='&YOCTO_DOCS_CM_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
| 3024 | section in the Getting Started With Yocto Project Manual. | 3024 | section in the Yocto Project Concepts Manual. |
| 3025 | </para> | 3025 | </para> |
| 3026 | </section> | 3026 | </section> |
| 3027 | 3027 | ||
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 1a409909bf..5d30987956 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
| @@ -520,10 +520,10 @@ | |||
| 520 | variable points to this directory. | 520 | variable points to this directory. |
| 521 | For more detail on the contents of the <filename>deploy</filename> | 521 | For more detail on the contents of the <filename>deploy</filename> |
| 522 | directory, see the | 522 | directory, see the |
| 523 | "<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>" | 523 | "<ulink url='&YOCTO_DOCS_CM_URL;#images-dev-environment'>Images</ulink>" |
| 524 | and | 524 | and |
| 525 | "<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>" | 525 | "<ulink url='&YOCTO_DOCS_CM_URL;#sdk-dev-environment'>Application Development SDK</ulink>" |
| 526 | sections in the Getting Started With Yocto Project Manual. | 526 | sections in the Yocto Project Concepts Manual. |
| 527 | </para> | 527 | </para> |
| 528 | </section> | 528 | </section> |
| 529 | 529 | ||
| @@ -696,8 +696,8 @@ | |||
| 696 | <para> | 696 | <para> |
| 697 | For information on how BitBake uses stamp files to determine if | 697 | For information on how BitBake uses stamp files to determine if |
| 698 | a task should be rerun, see the | 698 | a task should be rerun, see the |
| 699 | "<ulink url='&YOCTO_DOCS_GS_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" | 699 | "<ulink url='&YOCTO_DOCS_CM_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" |
| 700 | section in the Getting Started With Yocto Project Manual. | 700 | section in the Yocto Project Concepts Manual. |
| 701 | </para> | 701 | </para> |
| 702 | </section> | 702 | </section> |
| 703 | 703 | ||
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 007d08f112..a463717fe7 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml | |||
| @@ -220,8 +220,8 @@ | |||
| 220 | 220 | ||
| 221 | <para> | 221 | <para> |
| 222 | For more information on image creation, see the | 222 | For more information on image creation, see the |
| 223 | "<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>" | 223 | "<ulink url='&YOCTO_DOCS_CM_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
| 224 | section in the Getting Started With Yocto Project Manual. | 224 | section in the Yocto Project Concepts Manual. |
| 225 | </para> | 225 | </para> |
| 226 | </section> | 226 | </section> |
| 227 | 227 | ||
| @@ -246,8 +246,8 @@ | |||
| 246 | 246 | ||
| 247 | <para> | 247 | <para> |
| 248 | For more information on image creation, see the | 248 | For more information on image creation, see the |
| 249 | "<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>" | 249 | "<ulink url='&YOCTO_DOCS_CM_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
| 250 | section in the Getting Started With Yocto Project Manual. | 250 | section in the Yocto Project Concepts Manual. |
| 251 | </para> | 251 | </para> |
| 252 | </section> | 252 | </section> |
| 253 | 253 | ||
| @@ -367,8 +367,8 @@ | |||
| 367 | <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename> | 367 | <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename> |
| 368 | directory in the package feeds area. | 368 | directory in the package feeds area. |
| 369 | For more information, see the | 369 | For more information, see the |
| 370 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 370 | "<ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
| 371 | section in the Getting Started With Yocto Project Manual. | 371 | section in the Yocto Project Concepts Manual. |
| 372 | </para> | 372 | </para> |
| 373 | </section> | 373 | </section> |
| 374 | 374 | ||
| @@ -381,8 +381,8 @@ | |||
| 381 | <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename> | 381 | <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename> |
| 382 | directory in the package feeds area. | 382 | directory in the package feeds area. |
| 383 | For more information, see the | 383 | For more information, see the |
| 384 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 384 | "<ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
| 385 | section in the Getting Started With Yocto Project Manual. | 385 | section in the Yocto Project Concepts Manual. |
| 386 | </para> | 386 | </para> |
| 387 | </section> | 387 | </section> |
| 388 | 388 | ||
| @@ -395,8 +395,8 @@ | |||
| 395 | <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename> | 395 | <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename> |
| 396 | directory in the package feeds area. | 396 | directory in the package feeds area. |
| 397 | For more information, see the | 397 | For more information, see the |
| 398 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 398 | "<ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
| 399 | section in the Getting Started With Yocto Project Manual. | 399 | section in the Yocto Project Concepts Manual. |
| 400 | </para> | 400 | </para> |
| 401 | </section> | 401 | </section> |
| 402 | 402 | ||
| @@ -408,8 +408,8 @@ | |||
| 408 | <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename> | 408 | <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename> |
| 409 | directory in the package feeds area. | 409 | directory in the package feeds area. |
| 410 | For more information, see the | 410 | For more information, see the |
| 411 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 411 | "<ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
| 412 | section Getting Started With Yocto Project Manual. | 412 | section Yocto Project Concepts Manual. |
| 413 | </para> | 413 | </para> |
| 414 | </section> | 414 | </section> |
| 415 | 415 | ||
| @@ -431,8 +431,8 @@ | |||
| 431 | <para> | 431 | <para> |
| 432 | Locates patch files and applies them to the source code. | 432 | Locates patch files and applies them to the source code. |
| 433 | See the | 433 | See the |
| 434 | "<ulink url='&YOCTO_DOCS_GS_URL;#patching-dev-environment'>Patching</ulink>" | 434 | "<ulink url='&YOCTO_DOCS_CM_URL;#patching-dev-environment'>Patching</ulink>" |
| 435 | section in the Getting Started With Yocto Project Manual for more | 435 | section in the Yocto Project Concepts Manual for more |
| 436 | information. | 436 | information. |
| 437 | </para> | 437 | </para> |
| 438 | </section> | 438 | </section> |
| @@ -452,8 +452,8 @@ | |||
| 452 | <para> | 452 | <para> |
| 453 | Creates the file and directory structure for an installable SDK. | 453 | Creates the file and directory structure for an installable SDK. |
| 454 | See the | 454 | See the |
| 455 | "<ulink url='&YOCTO_DOCS_GS_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>" | 455 | "<ulink url='&YOCTO_DOCS_CM_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>" |
| 456 | section in the Getting Started With Yocto Project Manual for more | 456 | section in the Yocto Project Concepts Manual for more |
| 457 | information. | 457 | information. |
| 458 | </para> | 458 | </para> |
| 459 | </section> | 459 | </section> |
| @@ -540,8 +540,8 @@ | |||
| 540 | <link linkend='var-S'><filename>S</filename></link> variable also | 540 | <link linkend='var-S'><filename>S</filename></link> variable also |
| 541 | plays a role in where unpacked source files ultimately reside. | 541 | plays a role in where unpacked source files ultimately reside. |
| 542 | For more information on how source files are unpacked, see the | 542 | For more information on how source files are unpacked, see the |
| 543 | "<ulink url='&YOCTO_DOCS_GS_URL;#source-fetching-dev-environment'>Source Fetching</ulink>" | 543 | "<ulink url='&YOCTO_DOCS_CM_URL;#source-fetching-dev-environment'>Source Fetching</ulink>" |
| 544 | section in the Getting Started With Yocto Project Manual and also | 544 | section in the Yocto Project Concepts Manual and also |
| 545 | see the <filename>WORKDIR</filename> and | 545 | see the <filename>WORKDIR</filename> and |
| 546 | <filename>S</filename> variable descriptions. | 546 | <filename>S</filename> variable descriptions. |
| 547 | </para> | 547 | </para> |
| @@ -762,7 +762,7 @@ | |||
| 762 | 762 | ||
| 763 | <para> | 763 | <para> |
| 764 | Creates or updates the index in the | 764 | Creates or updates the index in the |
| 765 | <ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink> | 765 | <ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink> |
| 766 | area. | 766 | area. |
| 767 | <note> | 767 | <note> |
| 768 | This task is not triggered with the | 768 | This task is not triggered with the |
| @@ -814,8 +814,8 @@ | |||
| 814 | Creates the root filesystem (file and directory structure) for an | 814 | Creates the root filesystem (file and directory structure) for an |
| 815 | image. | 815 | image. |
| 816 | See the | 816 | See the |
| 817 | "<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>" | 817 | "<ulink url='&YOCTO_DOCS_CM_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
| 818 | section in the Getting Started With Yocto Project Manual for more | 818 | section in the Yocto Project Concepts Manual for more |
| 819 | information on how the root filesystem is created. | 819 | information on how the root filesystem is created. |
| 820 | </para> | 820 | </para> |
| 821 | </section> | 821 | </section> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index f2497249b5..137a556d92 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
| @@ -3329,13 +3329,11 @@ | |||
| 3329 | section. | 3329 | section. |
| 3330 | For more detail on the contents of the | 3330 | For more detail on the contents of the |
| 3331 | <filename>deploy</filename> directory, see the | 3331 | <filename>deploy</filename> directory, see the |
| 3332 | "<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>" | 3332 | "<ulink url='&YOCTO_DOCS_CM_URL;#images-dev-environment'>Images</ulink>", |
| 3333 | section, the | 3333 | "<ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>", |
| 3334 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3334 | and |
| 3335 | section, and the | 3335 | "<ulink url='&YOCTO_DOCS_CM_URL;#sdk-dev-environment'>Application Development SDK</ulink>" |
| 3336 | "<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>" | 3336 | sections all in the Yocto Project Concepts Manual. |
| 3337 | sections all in the Getting Started With Yocto Project | ||
| 3338 | Manual. | ||
| 3339 | </para> | 3337 | </para> |
| 3340 | </glossdef> | 3338 | </glossdef> |
| 3341 | </glossentry> | 3339 | </glossentry> |
| @@ -3374,8 +3372,8 @@ | |||
| 3374 | <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link> | 3372 | <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link> |
| 3375 | task writes Debian packages into the appropriate folder. | 3373 | task writes Debian packages into the appropriate folder. |
| 3376 | For more information on how packaging works, see the | 3374 | For more information on how packaging works, see the |
| 3377 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3375 | "<ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
| 3378 | section in the Getting Started With Yocto Project Manual. | 3376 | section in the Yocto Project Concepts Manual. |
| 3379 | </para> | 3377 | </para> |
| 3380 | </glossdef> | 3378 | </glossdef> |
| 3381 | </glossentry> | 3379 | </glossentry> |
| @@ -3404,11 +3402,10 @@ | |||
| 3404 | section. | 3402 | section. |
| 3405 | For more detail on the contents of the | 3403 | For more detail on the contents of the |
| 3406 | <filename>deploy</filename> directory, see the | 3404 | <filename>deploy</filename> directory, see the |
| 3407 | "<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>" | 3405 | "<ulink url='&YOCTO_DOCS_CM_URL;#images-dev-environment'>Images</ulink>" |
| 3408 | and | 3406 | and |
| 3409 | "<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>" | 3407 | "<ulink url='&YOCTO_DOCS_CM_URL;#sdk-dev-environment'>Application Development SDK</ulink>" |
| 3410 | sections both in the Getting Started With Yocto Project | 3408 | sections both in the Yocto Project Concepts Manual. |
| 3411 | Manual. | ||
| 3412 | </para> | 3409 | </para> |
| 3413 | </glossdef> | 3410 | </glossdef> |
| 3414 | </glossentry> | 3411 | </glossentry> |
| @@ -3446,8 +3443,8 @@ | |||
| 3446 | <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> | 3443 | <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> |
| 3447 | task writes IPK packages into the appropriate folder. | 3444 | task writes IPK packages into the appropriate folder. |
| 3448 | For more information on how packaging works, see the | 3445 | For more information on how packaging works, see the |
| 3449 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3446 | "<ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
| 3450 | section in the Getting Started With Yocto Project Manual. | 3447 | section in the Yocto Project Concepts Manual. |
| 3451 | </para> | 3448 | </para> |
| 3452 | </glossdef> | 3449 | </glossdef> |
| 3453 | </glossentry> | 3450 | </glossentry> |
| @@ -3485,8 +3482,8 @@ | |||
| 3485 | <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link> | 3482 | <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link> |
| 3486 | task writes RPM packages into the appropriate folder. | 3483 | task writes RPM packages into the appropriate folder. |
| 3487 | For more information on how packaging works, see the | 3484 | For more information on how packaging works, see the |
| 3488 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3485 | "<ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
| 3489 | section. | 3486 | section in the Yocto Project Concepts Manual. |
| 3490 | </para> | 3487 | </para> |
| 3491 | </glossdef> | 3488 | </glossdef> |
| 3492 | </glossentry> | 3489 | </glossentry> |
| @@ -3524,8 +3521,8 @@ | |||
| 3524 | <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link> | 3521 | <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link> |
| 3525 | task writes TAR packages into the appropriate folder. | 3522 | task writes TAR packages into the appropriate folder. |
| 3526 | For more information on how packaging works, see the | 3523 | For more information on how packaging works, see the |
| 3527 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3524 | "<ulink url='&YOCTO_DOCS_CM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
| 3528 | section in the Getting Started With Yocto Project Manual. | 3525 | section in the Yocto Project Concepts Manual. |
| 3529 | </para> | 3526 | </para> |
| 3530 | </glossdef> | 3527 | </glossdef> |
| 3531 | </glossentry> | 3528 | </glossentry> |
| @@ -6086,8 +6083,8 @@ | |||
| 6086 | variables. | 6083 | variables. |
| 6087 | You can find information on how the image | 6084 | You can find information on how the image |
| 6088 | is created in the | 6085 | is created in the |
| 6089 | "<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>" | 6086 | "<ulink url='&YOCTO_DOCS_CM_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
| 6090 | section in the Getting Started With Yocto Project Manual. | 6087 | section in the Yocto Project Concepts Manual. |
| 6091 | </para> | 6088 | </para> |
| 6092 | </glossdef> | 6089 | </glossdef> |
| 6093 | </glossentry> | 6090 | </glossentry> |
| @@ -13697,8 +13694,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 13697 | <para> | 13694 | <para> |
| 13698 | For information on how BitBake uses stamp files to determine | 13695 | For information on how BitBake uses stamp files to determine |
| 13699 | if a task should be rerun, see the | 13696 | if a task should be rerun, see the |
| 13700 | "<ulink url='&YOCTO_DOCS_GS_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" | 13697 | "<ulink url='&YOCTO_DOCS_CM_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" |
| 13701 | section in the Getting Started With Yocto Project Manual. | 13698 | section in the Yocto Project Concepts Manual. |
| 13702 | </para> | 13699 | </para> |
| 13703 | 13700 | ||
| 13704 | <para> | 13701 | <para> |
