mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-30 00:20:08 +00:00
Code Issues Projects Releases Wiki Activity

documentation: Updated everything for new overview-manual

Browse Source 
This involved changing the root manual folder from
"getting-started" to "overview-manual".

Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL".  Most manuals had several
occurrences of these links.

The makefile needed updating to process the new manual
and not process the old "getting-started" manual.

(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-04-12 10:57:32 -07:00
committed by Richard Purdie
parent 7105c52799
commit 1b877bc9dd
26 changed files with 118 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/ref-variables.xml
+24 -24
View File
@@ -3017,7 +3017,7 @@
<note><title>Caution</title>
Tasks that read from or write to this directory should
run under
<ulink url='&YOCTO_DOCS_GS_URL;#fakeroot-and-pseudo'>fakeroot</ulink>.
<ulink url='&YOCTO_DOCS_OM_URL;#fakeroot-and-pseudo'>fakeroot</ulink>.
</note>
</para>
</glossdef>
@@ -3264,7 +3264,7 @@
add any runtime dependencies between the
packages produced by the two recipes.
However, as explained in the
"<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Overview and
Concepts Manual, runtime dependencies will
often be added automatically, meaning
@@ -3329,10 +3329,10 @@
section.
For more detail on the contents of the
<filename>deploy</filename> directory, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>",
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>",
"<ulink url='&YOCTO_DOCS_OM_URL;#images-dev-environment'>Images</ulink>",
"<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>",
and
"<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#sdk-dev-environment'>Application Development SDK</ulink>"
sections all in the Yocto Project Overview and Concepts
Manual.
</para>
@@ -3373,7 +3373,7 @@
<link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link>
task writes Debian packages into the appropriate folder.
For more information on how packaging works, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
</glossdef>
@@ -3403,9 +3403,9 @@
section.
For more detail on the contents of the
<filename>deploy</filename> directory, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#images-dev-environment'>Images</ulink>"
and
"<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#sdk-dev-environment'>Application Development SDK</ulink>"
sections both in the Yocto Project Overview and Concepts
Manual.
</para>
@@ -3445,7 +3445,7 @@
<link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>
task writes IPK packages into the appropriate folder.
For more information on how packaging works, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
</glossdef>
@@ -3484,7 +3484,7 @@
<link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link>
task writes RPM packages into the appropriate folder.
For more information on how packaging works, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
</glossdef>
@@ -3523,7 +3523,7 @@
<link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link>
task writes TAR packages into the appropriate folder.
For more information on how packaging works, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
</glossdef>
@@ -4865,7 +4865,7 @@
The previous statement appears in the
<filename>linux-yocto-dev.bbappend</filename> file, which
is found in the Yocto Project
<ulink url='&YOCTO_DOCS_GS_URL;#source-repositories'>Source Repositories</ulink>
<ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink>
in
<filename>meta-intel/common/recipes-kernel/linux</filename>.
Here, the machine override is a special
@@ -6106,7 +6106,7 @@
variables.
You can find information on how the image
is created in the
"<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#image-generation-dev-environment'>Image Generation</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
</glossdef>
@@ -7980,7 +7980,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<link linkend='var-LICENSE'><filename>LICENSE</filename></link>
is set to "CLOSED").</para>
<para>For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
</glossdef>
@@ -8116,7 +8116,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
require additional licenses in order to be used in a
commercial product.
For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
</glossdef>
@@ -8136,7 +8136,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
This practice is otherwise known as "whitelisting"
license flags.
For more information, see the
<ulink url='&YOCTO_DOCS_GS_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>"
<ulink url='&YOCTO_DOCS_OM_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
</glossdef>
@@ -10490,7 +10490,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
${STAGING_DIR_HOST}/pkgdata
</literallayout>
For examples of how this data is used, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Overview and Concepts Manual
and the
"<ulink url='&YOCTO_DOCS_DEV_URL;#viewing-package-information-with-oe-pkgdata-util'>Viewing Package Information with <filename>oe-pkgdata-util</filename></ulink>"
@@ -10738,11 +10738,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<filename>PR</filename> to know when to rebuild a
recipe.
The build system uses the task
<ulink url='&YOCTO_DOCS_GS_URL;#overview-checksums'>input checksums</ulink>
<ulink url='&YOCTO_DOCS_OM_URL;#overview-checksums'>input checksums</ulink>
along with the
<link linkend='structure-build-tmp-stamps'>stamp</link>
and
<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>shared state cache</ulink>
<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>shared state cache</ulink>
mechanisms.
</note>
The <filename>PR</filename> variable primarily becomes
@@ -11011,7 +11011,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<para>
For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
</glossdef>
@@ -11328,7 +11328,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Therefore, most recipes do not need to set
<filename>RDEPENDS</filename>.
For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
@@ -13848,7 +13848,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<para>
For information on how BitBake uses stamp files to determine
if a task should be rerun, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>"
section in the Yocto Project Overview and Concepts Manual.
</para>
@@ -15340,7 +15340,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<para>
For background information on cross-development toolchains
in the Yocto Project development environment, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Overview and Concepts Manual.
For information on setting up a cross-development
environment, see the
@@ -15399,7 +15399,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<para>
For background information on cross-development toolchains
in the Yocto Project development environment, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Overview and Concepts Manual.
For information on setting up a cross-development
environment, see the