mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 17:39:31 +00:00
Code Issues Projects Releases Wiki Activity

documentation: Purged overview manual references

Browse Source 
When I converted the Yocto Project Overview Manual to the Getting
Started With Yocto Project Manual, I updated the strings for
references from "&YOCTO_DOCS_OVERVIEW_URL" TO
"&YOCTO_DOCS_GS_URL".  Unfortunately, I did it with a global command
that did not take into account the text the might follow the link
by saying "see such-and-such section in the Yocto Project Overview
Manual."  So, I had to hand fix these.

Additionally, since I have moved a deeper concepts chapter that
was in the getting-started manual to a new Yocto Project Concepts
chapter, many of those links changed had to really go to the new
manual instead.  Those were fixed.

(From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a)

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-01-30 13:45:31 -08:00
committed by Richard Purdie
parent 31bd483368
commit 4d623003f3
19 changed files with 110 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/faq.xml
+2 -1
View File
@@ -418,7 +418,8 @@
<para>
You can find more information on licensing in the
"<ulink url='&YOCTO_DOCS_GS_URL;#licensing'>Licensing</ulink>"
section in the Yocto Project Overview Manual and also in the
section in the Getting Started With Yocto Project Manual
and also in the
"<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
section in the Yocto Project Development Tasks Manual.
</para>
documentation/ref-manual/ref-bitbake.xml
+2 -2
View File
@@ -350,8 +350,8 @@
checksums.
For information on this process, see the
<filename>BB_HASHBASE_WHITELIST</filename> example in the
"<ulink url='&YOCTO_DOCS_GS_URL;#overview-checksums'>Checksums (Signatures)</ulink>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#overview-checksums'>Checksums (Signatures)</ulink>"
section in the Yocto Project Concepts Manual.
</note>
</section>
documentation/ref-manual/ref-classes.xml
+10 -10
View File
@@ -568,8 +568,8 @@
provides support for the recipes that build the Canadian
Cross-compilation tools for SDKs.
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Overview Manual for more discussion on
"<ulink url='&YOCTO_DOCS_CM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Concepts Manual for more discussion on
these cross-compilation tools.
</para>
</section>
@@ -582,8 +582,8 @@
provides support for the recipes that build the cross-compilation
tools used for building SDKs.
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Overview Manual for more discussion on
"<ulink url='&YOCTO_DOCS_CM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Concepts Manual for more discussion on
these cross-compilation tools.
</para>
</section>
@@ -1252,7 +1252,7 @@
section in the Yocto Project Development Tasks Manual.
For information on how images are created, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</section>
@@ -2722,8 +2722,8 @@ This check was removed for YP 2.3 release
<para>
For more information on the cross-development toolchain
generation, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Concepts Manual.
For information on advantages gained when building a
cross-development toolchain using the
<link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link>
@@ -3021,7 +3021,7 @@ This check was removed for YP 2.3 release
<para>
For information on how root filesystem images are created, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</section>
@@ -3182,8 +3182,8 @@ This check was removed for YP 2.3 release
<para>
For more information on sstate, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>Shared State Cache</ulink>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#shared-state-cache'>Shared State Cache</ulink>"
section in the Yocto Project Concepts Manual.
</para>
</section>
documentation/ref-manual/ref-images.xml
+2 -2
View File
@@ -151,8 +151,8 @@
This image provides the Wayland protocol libraries and the
reference Weston compositor.
For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#wayland'>Wayland</ulink>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#wayland'>Wayland</ulink>"
section in the Yocto Project Concepts Manual.
</para></listitem>
<listitem><para><filename>core-image-x11</filename>:
A very basic X11 image with a terminal.
documentation/ref-manual/ref-structure.xml
+2 -2
View File
@@ -523,7 +523,7 @@
"<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>"
and
"<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>"
sections in the Yocto Project Overview Manual.
sections in the Getting Started With Yocto Project Manual.
</para>
</section>
@@ -697,7 +697,7 @@
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>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</section>
documentation/ref-manual/ref-system-requirements.xml
+1 -1
View File
@@ -22,7 +22,7 @@
For introductory information on the Yocto Project, see the
<ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and the
"<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>Yocto Project Development Environment</ulink>"
chapter in the Yocto Project Overview Manual.
chapter in the Getting Started With Yocto Project Manual.
</para>
<para>
documentation/ref-manual/ref-tasks.xml
+16 -14
View File
@@ -221,7 +221,7 @@
<para>
For more information on image creation, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</section>
@@ -247,7 +247,7 @@
<para>
For more information on image creation, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</section>
@@ -342,8 +342,8 @@
For additional information, see the
<link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link>
variable and the
"<ulink url='&YOCTO_DOCS_GS_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Concepts Manual.
</para>
</section>
@@ -368,7 +368,7 @@
directory in the package feeds area.
For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</section>
@@ -382,7 +382,7 @@
directory in the package feeds area.
For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</section>
@@ -396,7 +396,7 @@
directory in the package feeds area.
For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</section>
@@ -409,7 +409,7 @@
directory in the package feeds area.
For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section Yocto Project Overview Manual.
section Getting Started With Yocto Project Manual.
</para>
</section>
@@ -432,7 +432,8 @@
Locates patch files and applies them to the source code.
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#patching-dev-environment'>Patching</ulink>"
section in the Yocto Project Overview Manual for more information.
section in the Getting Started With Yocto Project Manual for more
information.
</para>
</section>
@@ -452,7 +453,8 @@
Creates the file and directory structure for an installable SDK.
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>"
section in the Yocto Project Overview Manual for more information.
section in the Getting Started With Yocto Project Manual for more
information.
</para>
</section>
@@ -539,8 +541,8 @@
plays a role in where unpacked source files ultimately reside.
For more information on how source files are unpacked, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#source-fetching-dev-environment'>Source Fetching</ulink>"
section in the Yocto Project Overview Manual and also see the
<filename>WORKDIR</filename> and
section in the Getting Started With Yocto Project Manual and also
see the <filename>WORKDIR</filename> and
<filename>S</filename> variable descriptions.
</para>
</section>
@@ -813,8 +815,8 @@
image.
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#image-generation-dev-environment'>Image Generation</ulink>"
section in the Yocto Project Overview Manual for more information
on how the root filesystem is created.
section in the Getting Started With Yocto Project Manual for more
information on how the root filesystem is created.
</para>
</section>
documentation/ref-manual/ref-terms.xml
+3 -3
View File
@@ -181,8 +181,8 @@
<para>Creation of these toolchains is simple and automated.
For information on toolchain concepts as they apply to the
Yocto Project, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Concepts Manual.
You can also find more information on using the
relocatable toolchain in the
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
@@ -400,7 +400,7 @@
<para>For more information on concepts related to Git
repositories, branches, and tags, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#repositories-tags-and-branches'>Repositories, Tags, and Branches</ulink>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para></listitem>
<listitem><para><emphasis>Task:</emphasis>
A unit of execution for BitBake (e.g.
documentation/ref-manual/ref-variables.xml
+30 -28
View File
@@ -3264,8 +3264,8 @@
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>"
section in the Yocto Project Overview Manual,
"<ulink url='&YOCTO_DOCS_CM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Concepts Manual,
runtime dependencies will often be
added automatically, meaning
<filename>DEPENDS</filename> alone is
@@ -3334,7 +3334,8 @@
"<ulink url='&YOCTO_DOCS_GS_URL;#package-feeds-dev-environment'>Package Feeds</ulink>"
section, and the
"<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>"
sections all in the Yocto Project Overview Manual.
sections all in the Getting Started With Yocto Project
Manual.
</para>
</glossdef>
</glossentry>
@@ -3374,7 +3375,7 @@
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>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</glossdef>
</glossentry>
@@ -3406,7 +3407,8 @@
"<ulink url='&YOCTO_DOCS_GS_URL;#images-dev-environment'>Images</ulink>"
and
"<ulink url='&YOCTO_DOCS_GS_URL;#sdk-dev-environment'>Application Development SDK</ulink>"
sections both in the Yocto Project Overview Manual.
sections both in the Getting Started With Yocto Project
Manual.
</para>
</glossdef>
</glossentry>
@@ -3445,7 +3447,7 @@
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>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</glossdef>
</glossentry>
@@ -3523,7 +3525,7 @@
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>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</glossdef>
</glossentry>
@@ -6085,7 +6087,7 @@
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>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
</glossdef>
</glossentry>
@@ -7911,8 +7913,8 @@ 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>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>"
section in the Yocto Project Concepts Manual.
</para>
</glossdef>
</glossentry>
@@ -8047,8 +8049,8 @@ 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>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>"
section in the Yocto Project Concepts Manual.
</para>
</glossdef>
</glossentry>
@@ -8067,8 +8069,8 @@ 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>"
section in the Yocto Project Overview Manual.
<ulink url='&YOCTO_DOCS_CM_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>"
section in the Yocto Project Concepts Manual.
</para>
</glossdef>
</glossentry>
@@ -10412,8 +10414,8 @@ 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>"
section in the Yocto Project Overview Manual and the
"<ulink url='&YOCTO_DOCS_CM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project 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>"
section in the Yocto Project Development Tasks Manual.
</para>
@@ -10659,7 +10661,7 @@ 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_CM_URL;#overview-checksums'>input checksums</ulink>
along with the
<link linkend='structure-build-tmp-stamps'>stamp</link>
and
@@ -10715,8 +10717,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
</literallayout>
For more information, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#metadata-virtual-providers'>Metadata (Virtual Providers)</ulink>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#metadata-virtual-providers'>Metadata (Virtual Providers)</ulink>"
section in the Yocto Project Concepts Manual.
<note>
If you set <filename>PREFERRED_PROVIDER</filename>
for a <filename>virtual/*</filename> item, then any
@@ -10919,8 +10921,8 @@ 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>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Concepts Manual.
</para>
</glossdef>
</glossentry>
@@ -11236,8 +11238,8 @@ 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>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>"
section in the Yocto Project Concepts Manual.
</para>
<para>
@@ -13696,7 +13698,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
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>"
section in the Yocto Project Overview Manual.
section in the Getting Started With Yocto Project Manual.
</para>
<para>
@@ -15187,8 +15189,8 @@ 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>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Concepts Manual.
For information on setting up a cross-development
environment, see the
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
@@ -15246,8 +15248,8 @@ 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>"
section in the Yocto Project Overview Manual.
"<ulink url='&YOCTO_DOCS_CM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
section in the Yocto Project Concepts Manual.
For information on setting up a cross-development
environment, see the
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
documentation/ref-manual/resources.xml
+3 -3
View File
@@ -167,10 +167,10 @@
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_GS_URL;'>Yocto Project Overview Manual</ulink>:
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project Manual</ulink>:
</emphasis>
This manual introduces the Yocto Project, provides development
environment basics, and explains Yocto Project concepts.
This manual introduces the Yocto Project and provides
development environment basics.
</para></listitem>
<listitem><para>
<emphasis>