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-variables.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-variables.xml')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 334336880b..f09e0b6ae4 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -3017,7 +3017,7 @@ | |||
3017 | <note><title>Caution</title> | 3017 | <note><title>Caution</title> |
3018 | Tasks that read from or write to this directory should | 3018 | Tasks that read from or write to this directory should |
3019 | run under | 3019 | run under |
3020 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#fakeroot-and-pseudo'>fakeroot</ulink>. | 3020 | <ulink url='&YOCTO_DOCS_GS_URL;#fakeroot-and-pseudo'>fakeroot</ulink>. |
3021 | </note> | 3021 | </note> |
3022 | </para> | 3022 | </para> |
3023 | </glossdef> | 3023 | </glossdef> |
@@ -3264,7 +3264,7 @@ | |||
3264 | add any runtime dependencies between the | 3264 | add any runtime dependencies between the |
3265 | packages produced by the two recipes. | 3265 | packages produced by the two recipes. |
3266 | However, as explained in the | 3266 | However, as explained in the |
3267 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" | 3267 | "<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" |
3268 | section in the Yocto Project Overview Manual, | 3268 | section in the Yocto Project Overview Manual, |
3269 | runtime dependencies will often be | 3269 | runtime dependencies will often be |
3270 | added automatically, meaning | 3270 | added automatically, meaning |
@@ -3329,11 +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_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" | 3332 | "<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>" |
3333 | section, the | 3333 | section, the |
3334 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3334 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3335 | section, and the | 3335 | section, and the |
3336 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-dev-environment'>Application Development SDK</ulink>" | 3336 | "<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>" |
3337 | sections all in the Yocto Project Overview Manual. | 3337 | sections all in the Yocto Project Overview Manual. |
3338 | </para> | 3338 | </para> |
3339 | </glossdef> | 3339 | </glossdef> |
@@ -3373,7 +3373,7 @@ | |||
3373 | <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link> | 3373 | <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link> |
3374 | task writes Debian packages into the appropriate folder. | 3374 | task writes Debian packages into the appropriate folder. |
3375 | For more information on how packaging works, see the | 3375 | For more information on how packaging works, see the |
3376 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3376 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3377 | section in the Yocto Project Overview Manual. | 3377 | section in the Yocto Project Overview Manual. |
3378 | </para> | 3378 | </para> |
3379 | </glossdef> | 3379 | </glossdef> |
@@ -3403,9 +3403,9 @@ | |||
3403 | section. | 3403 | section. |
3404 | For more detail on the contents of the | 3404 | For more detail on the contents of the |
3405 | <filename>deploy</filename> directory, see the | 3405 | <filename>deploy</filename> directory, see the |
3406 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" | 3406 | "<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>" |
3407 | and | 3407 | and |
3408 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-dev-environment'>Application Development SDK</ulink>" | 3408 | "<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>" |
3409 | sections both in the Yocto Project Overview Manual. | 3409 | sections both in the Yocto Project Overview Manual. |
3410 | </para> | 3410 | </para> |
3411 | </glossdef> | 3411 | </glossdef> |
@@ -3444,7 +3444,7 @@ | |||
3444 | <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> | 3444 | <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> |
3445 | task writes IPK packages into the appropriate folder. | 3445 | task writes IPK packages into the appropriate folder. |
3446 | For more information on how packaging works, see the | 3446 | For more information on how packaging works, see the |
3447 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3447 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3448 | section in the Yocto Project Overview Manual. | 3448 | section in the Yocto Project Overview Manual. |
3449 | </para> | 3449 | </para> |
3450 | </glossdef> | 3450 | </glossdef> |
@@ -3483,7 +3483,7 @@ | |||
3483 | <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link> | 3483 | <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link> |
3484 | task writes RPM packages into the appropriate folder. | 3484 | task writes RPM packages into the appropriate folder. |
3485 | For more information on how packaging works, see the | 3485 | For more information on how packaging works, see the |
3486 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3486 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3487 | section. | 3487 | section. |
3488 | </para> | 3488 | </para> |
3489 | </glossdef> | 3489 | </glossdef> |
@@ -3522,7 +3522,7 @@ | |||
3522 | <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link> | 3522 | <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link> |
3523 | task writes TAR packages into the appropriate folder. | 3523 | task writes TAR packages into the appropriate folder. |
3524 | For more information on how packaging works, see the | 3524 | For more information on how packaging works, see the |
3525 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" | 3525 | "<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3526 | section in the Yocto Project Overview Manual. | 3526 | section in the Yocto Project Overview Manual. |
3527 | </para> | 3527 | </para> |
3528 | </glossdef> | 3528 | </glossdef> |
@@ -4864,7 +4864,7 @@ | |||
4864 | The previous statement appears in the | 4864 | The previous statement appears in the |
4865 | <filename>linux-yocto-dev.bbappend</filename> file, which | 4865 | <filename>linux-yocto-dev.bbappend</filename> file, which |
4866 | is found in the Yocto Project | 4866 | is found in the Yocto Project |
4867 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> | 4867 | <ulink url='&YOCTO_DOCS_GS_URL;#source-repositories'>Source Repositories</ulink> |
4868 | in | 4868 | in |
4869 | <filename>meta-intel/common/recipes-kernel/linux</filename>. | 4869 | <filename>meta-intel/common/recipes-kernel/linux</filename>. |
4870 | Here, the machine override is a special | 4870 | Here, the machine override is a special |
@@ -6084,7 +6084,7 @@ | |||
6084 | variables. | 6084 | variables. |
6085 | You can find information on how the image | 6085 | You can find information on how the image |
6086 | is created in the | 6086 | is created in the |
6087 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" | 6087 | "<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
6088 | section in the Yocto Project Overview Manual. | 6088 | section in the Yocto Project Overview Manual. |
6089 | </para> | 6089 | </para> |
6090 | </glossdef> | 6090 | </glossdef> |
@@ -7911,7 +7911,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
7911 | <link linkend='var-LICENSE'><filename>LICENSE</filename></link> | 7911 | <link linkend='var-LICENSE'><filename>LICENSE</filename></link> |
7912 | is set to "CLOSED").</para> | 7912 | is set to "CLOSED").</para> |
7913 | <para>For more information, see the | 7913 | <para>For more information, see the |
7914 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" | 7914 | "<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" |
7915 | section in the Yocto Project Overview Manual. | 7915 | section in the Yocto Project Overview Manual. |
7916 | </para> | 7916 | </para> |
7917 | </glossdef> | 7917 | </glossdef> |
@@ -8047,7 +8047,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
8047 | require additional licenses in order to be used in a | 8047 | require additional licenses in order to be used in a |
8048 | commercial product. | 8048 | commercial product. |
8049 | For more information, see the | 8049 | For more information, see the |
8050 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>" | 8050 | "<ulink url='&YOCTO_DOCS_GS_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>" |
8051 | section in the Yocto Project Overview Manual. | 8051 | section in the Yocto Project Overview Manual. |
8052 | </para> | 8052 | </para> |
8053 | </glossdef> | 8053 | </glossdef> |
@@ -8067,7 +8067,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
8067 | This practice is otherwise known as "whitelisting" | 8067 | This practice is otherwise known as "whitelisting" |
8068 | license flags. | 8068 | license flags. |
8069 | For more information, see the | 8069 | For more information, see the |
8070 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>" | 8070 | <ulink url='&YOCTO_DOCS_GS_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>" |
8071 | section in the Yocto Project Overview Manual. | 8071 | section in the Yocto Project Overview Manual. |
8072 | </para> | 8072 | </para> |
8073 | </glossdef> | 8073 | </glossdef> |
@@ -10412,7 +10412,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
10412 | ${STAGING_DIR_HOST}/pkgdata | 10412 | ${STAGING_DIR_HOST}/pkgdata |
10413 | </literallayout> | 10413 | </literallayout> |
10414 | For examples of how this data is used, see the | 10414 | For examples of how this data is used, see the |
10415 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" | 10415 | "<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" |
10416 | section in the Yocto Project Overview Manual and the | 10416 | section in the Yocto Project Overview Manual and the |
10417 | "<ulink url='&YOCTO_DOCS_DEV_URL;#viewing-package-information-with-oe-pkgdata-util'>Viewing Package Information with <filename>oe-pkgdata-util</filename></ulink>" | 10417 | "<ulink url='&YOCTO_DOCS_DEV_URL;#viewing-package-information-with-oe-pkgdata-util'>Viewing Package Information with <filename>oe-pkgdata-util</filename></ulink>" |
10418 | section in the Yocto Project Development Tasks Manual. | 10418 | section in the Yocto Project Development Tasks Manual. |
@@ -10659,11 +10659,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
10659 | <filename>PR</filename> to know when to rebuild a | 10659 | <filename>PR</filename> to know when to rebuild a |
10660 | recipe. | 10660 | recipe. |
10661 | The build system uses the task | 10661 | The build system uses the task |
10662 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#overview-checksums'>input checksums</ulink> | 10662 | <ulink url='&YOCTO_DOCS_GS_URL;#overview-checksums'>input checksums</ulink> |
10663 | along with the | 10663 | along with the |
10664 | <link linkend='structure-build-tmp-stamps'>stamp</link> | 10664 | <link linkend='structure-build-tmp-stamps'>stamp</link> |
10665 | and | 10665 | and |
10666 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#shared-state-cache'>shared state cache</ulink> | 10666 | <ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>shared state cache</ulink> |
10667 | mechanisms. | 10667 | mechanisms. |
10668 | </note> | 10668 | </note> |
10669 | The <filename>PR</filename> variable primarily becomes | 10669 | The <filename>PR</filename> variable primarily becomes |
@@ -10715,7 +10715,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
10715 | PREFERRED_PROVIDER_virtual/libgl ?= "mesa" | 10715 | PREFERRED_PROVIDER_virtual/libgl ?= "mesa" |
10716 | </literallayout> | 10716 | </literallayout> |
10717 | For more information, see the | 10717 | For more information, see the |
10718 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#metadata-virtual-providers'>Metadata (Virtual Providers)</ulink>" | 10718 | "<ulink url='&YOCTO_DOCS_GS_URL;#metadata-virtual-providers'>Metadata (Virtual Providers)</ulink>" |
10719 | section in the Yocto Project Overview Manual. | 10719 | section in the Yocto Project Overview Manual. |
10720 | <note> | 10720 | <note> |
10721 | If you set <filename>PREFERRED_PROVIDER</filename> | 10721 | If you set <filename>PREFERRED_PROVIDER</filename> |
@@ -10919,7 +10919,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
10919 | 10919 | ||
10920 | <para> | 10920 | <para> |
10921 | For more information, see the | 10921 | For more information, see the |
10922 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" | 10922 | "<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" |
10923 | section in the Yocto Project Overview Manual. | 10923 | section in the Yocto Project Overview Manual. |
10924 | </para> | 10924 | </para> |
10925 | </glossdef> | 10925 | </glossdef> |
@@ -11236,7 +11236,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
11236 | Therefore, most recipes do not need to set | 11236 | Therefore, most recipes do not need to set |
11237 | <filename>RDEPENDS</filename>. | 11237 | <filename>RDEPENDS</filename>. |
11238 | For more information, see the | 11238 | For more information, see the |
11239 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" | 11239 | "<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" |
11240 | section in the Yocto Project Overview Manual. | 11240 | section in the Yocto Project Overview Manual. |
11241 | </para> | 11241 | </para> |
11242 | 11242 | ||
@@ -13695,7 +13695,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
13695 | <para> | 13695 | <para> |
13696 | For information on how BitBake uses stamp files to determine | 13696 | For information on how BitBake uses stamp files to determine |
13697 | if a task should be rerun, see the | 13697 | if a task should be rerun, see the |
13698 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" | 13698 | "<ulink url='&YOCTO_DOCS_GS_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" |
13699 | section in the Yocto Project Overview Manual. | 13699 | section in the Yocto Project Overview Manual. |
13700 | </para> | 13700 | </para> |
13701 | 13701 | ||
@@ -15187,7 +15187,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
15187 | <para> | 15187 | <para> |
15188 | For background information on cross-development toolchains | 15188 | For background information on cross-development toolchains |
15189 | in the Yocto Project development environment, see the | 15189 | in the Yocto Project development environment, see the |
15190 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" | 15190 | "<ulink url='&YOCTO_DOCS_GS_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" |
15191 | section in the Yocto Project Overview Manual. | 15191 | section in the Yocto Project Overview Manual. |
15192 | For information on setting up a cross-development | 15192 | For information on setting up a cross-development |
15193 | environment, see the | 15193 | environment, see the |
@@ -15246,7 +15246,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
15246 | <para> | 15246 | <para> |
15247 | For background information on cross-development toolchains | 15247 | For background information on cross-development toolchains |
15248 | in the Yocto Project development environment, see the | 15248 | in the Yocto Project development environment, see the |
15249 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" | 15249 | "<ulink url='&YOCTO_DOCS_GS_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" |
15250 | section in the Yocto Project Overview Manual. | 15250 | section in the Yocto Project Overview Manual. |
15251 | For information on setting up a cross-development | 15251 | For information on setting up a cross-development |
15252 | environment, see the | 15252 | environment, see the |