diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-01-29 15:18:03 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-02-14 15:25:29 +0000 |
commit | ae06e04cd225d2c2147ca355e2dd39b4f6cf6775 (patch) | |
tree | c920e85262a91e7626279e7dcbbd56a299919f49 /documentation/ref-manual/ref-tasks.xml | |
parent | ebc7de094881dd8f2450aa4fdf548f2e9c835df1 (diff) | |
download | poky-ae06e04cd225d2c2147ca355e2dd39b4f6cf6775.tar.gz |
documentation: Created new "Getting Started" manual.
Creation involved removing the overview-manual and replacing it
with the getting-started manual. All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".
The style sheet for the new manual needed updating to display the
new .PNG image for the title page. The mega-manual file had to
be updated to include the files. The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.
(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-tasks.xml')
-rw-r--r-- | documentation/ref-manual/ref-tasks.xml | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 4fa64c0d60..262dec8311 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml | |||
@@ -220,7 +220,7 @@ | |||
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_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" | 223 | "<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
224 | section in the Yocto Project Overview Manual. | 224 | section in the Yocto Project Overview Manual. |
225 | </para> | 225 | </para> |
226 | </section> | 226 | </section> |
@@ -246,7 +246,7 @@ | |||
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_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" | 249 | "<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
250 | section in the Yocto Project Overview Manual. | 250 | section in the Yocto Project Overview Manual. |
251 | </para> | 251 | </para> |
252 | </section> | 252 | </section> |
@@ -268,7 +268,7 @@ | |||
268 | and | 268 | and |
269 | <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>), | 269 | <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>), |
270 | run under | 270 | run under |
271 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#fakeroot-and-pseudo'>fakeroot</ulink>. | 271 | <ulink url='&YOCTO_DOCS_GS_URL;#fakeroot-and-pseudo'>fakeroot</ulink>. |
272 | <note> | 272 | <note> |
273 | <title>Caution</title> | 273 | <title>Caution</title> |
274 | 274 | ||
@@ -342,7 +342,7 @@ | |||
342 | For additional information, see the | 342 | For additional information, see the |
343 | <link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link> | 343 | <link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link> |
344 | variable and the | 344 | variable and the |
345 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" | 345 | "<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" |
346 | section in the Yocto Project Overview Manual. | 346 | section in the Yocto Project Overview Manual. |
347 | </para> | 347 | </para> |
348 | </section> | 348 | </section> |
@@ -367,7 +367,7 @@ | |||
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_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 370 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
371 | section in the Yocto Project Overview Manual. | 371 | section in the Yocto Project Overview Manual. |
372 | </para> | 372 | </para> |
373 | </section> | 373 | </section> |
@@ -381,7 +381,7 @@ | |||
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_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 384 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
385 | section in the Yocto Project Overview Manual. | 385 | section in the Yocto Project Overview Manual. |
386 | </para> | 386 | </para> |
387 | </section> | 387 | </section> |
@@ -395,7 +395,7 @@ | |||
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_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 398 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
399 | section in the Yocto Project Overview Manual. | 399 | section in the Yocto Project Overview Manual. |
400 | </para> | 400 | </para> |
401 | </section> | 401 | </section> |
@@ -408,7 +408,7 @@ | |||
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_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 411 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
412 | section Yocto Project Overview Manual. | 412 | section Yocto Project Overview Manual. |
413 | </para> | 413 | </para> |
414 | </section> | 414 | </section> |
@@ -431,7 +431,7 @@ | |||
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_OVERVIEW_URL;#patching-dev-environment'>Patching</ulink>" | 434 | "<ulink url='&YOCTO_DOCS_GS_URL;#patching-dev-environment'>Patching</ulink>" |
435 | section in the Yocto Project Overview Manual for more information. | 435 | section in the Yocto Project Overview Manual for more information. |
436 | </para> | 436 | </para> |
437 | </section> | 437 | </section> |
@@ -451,7 +451,7 @@ | |||
451 | <para> | 451 | <para> |
452 | Creates the file and directory structure for an installable SDK. | 452 | Creates the file and directory structure for an installable SDK. |
453 | See the | 453 | See the |
454 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>" | 454 | "<ulink url='&YOCTO_DOCS_GS_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>" |
455 | section in the Yocto Project Overview Manual for more information. | 455 | section in the Yocto Project Overview Manual for more information. |
456 | </para> | 456 | </para> |
457 | </section> | 457 | </section> |
@@ -538,7 +538,7 @@ | |||
538 | <link linkend='var-S'><filename>S</filename></link> variable also | 538 | <link linkend='var-S'><filename>S</filename></link> variable also |
539 | plays a role in where unpacked source files ultimately reside. | 539 | plays a role in where unpacked source files ultimately reside. |
540 | For more information on how source files are unpacked, see the | 540 | For more information on how source files are unpacked, see the |
541 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-fetching-dev-environment'>Source Fetching</ulink>" | 541 | "<ulink url='&YOCTO_DOCS_GS_URL;#source-fetching-dev-environment'>Source Fetching</ulink>" |
542 | section in the Yocto Project Overview Manual and also see the | 542 | section in the Yocto Project Overview Manual and also see the |
543 | <filename>WORKDIR</filename> and | 543 | <filename>WORKDIR</filename> and |
544 | <filename>S</filename> variable descriptions. | 544 | <filename>S</filename> variable descriptions. |
@@ -628,7 +628,7 @@ | |||
628 | 628 | ||
629 | <para> | 629 | <para> |
630 | Running this task does not remove the | 630 | Running this task does not remove the |
631 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>sstate</ulink> | 631 | <ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink> |
632 | cache files. | 632 | cache files. |
633 | Consequently, if no changes have been made and the recipe is | 633 | Consequently, if no changes have been made and the recipe is |
634 | rebuilt after cleaning, output files are simply restored from the | 634 | rebuilt after cleaning, output files are simply restored from the |
@@ -645,7 +645,7 @@ | |||
645 | 645 | ||
646 | <para> | 646 | <para> |
647 | Removes all output files, shared state | 647 | Removes all output files, shared state |
648 | (<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>sstate</ulink>) | 648 | (<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>) |
649 | cache, and downloaded source files for a target (i.e. the contents | 649 | cache, and downloaded source files for a target (i.e. the contents |
650 | of | 650 | of |
651 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>). | 651 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>). |
@@ -676,13 +676,13 @@ | |||
676 | 676 | ||
677 | <para> | 677 | <para> |
678 | Removes all output files and shared state | 678 | Removes all output files and shared state |
679 | (<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>sstate</ulink>) | 679 | (<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>) |
680 | cache for a target. | 680 | cache for a target. |
681 | Essentially, the <filename>do_cleansstate</filename> task is | 681 | Essentially, the <filename>do_cleansstate</filename> task is |
682 | identical to the | 682 | identical to the |
683 | <link linkend='ref-tasks-clean'><filename>do_clean</filename></link> | 683 | <link linkend='ref-tasks-clean'><filename>do_clean</filename></link> |
684 | task with the added removal of shared state | 684 | task with the added removal of shared state |
685 | (<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>sstate</ulink>) | 685 | (<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>) |
686 | cache. | 686 | cache. |
687 | </para> | 687 | </para> |
688 | 688 | ||
@@ -760,7 +760,7 @@ | |||
760 | 760 | ||
761 | <para> | 761 | <para> |
762 | Creates or updates the index in the | 762 | Creates or updates the index in the |
763 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink> | 763 | <ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink> |
764 | area. | 764 | area. |
765 | <note> | 765 | <note> |
766 | This task is not triggered with the | 766 | This task is not triggered with the |
@@ -812,7 +812,7 @@ | |||
812 | Creates the root filesystem (file and directory structure) for an | 812 | Creates the root filesystem (file and directory structure) for an |
813 | image. | 813 | image. |
814 | See the | 814 | See the |
815 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" | 815 | "<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
816 | section in the Yocto Project Overview Manual for more information | 816 | section in the Yocto Project Overview Manual for more information |
817 | on how the root filesystem is created. | 817 | on how the root filesystem is created. |
818 | </para> | 818 | </para> |