documentation: Updated everything for new overview-manual

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 3a8b4648d4
commit 0b07e5c00d
26 changed files with 118 additions and 122 deletions

View File

@@ -220,7 +220,7 @@
<para>
For more information on image creation, see 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>
</section>
@@ -246,7 +246,7 @@
<para>
For more information on image creation, see 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>
</section>
@@ -268,7 +268,7 @@
and
<link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>),
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>
<title>Caution</title>
@@ -342,7 +342,7 @@
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>"
"<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>
</section>
@@ -367,7 +367,7 @@
<filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename>
directory in the package feeds area.
For more information, 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>
</section>
@@ -381,7 +381,7 @@
<filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename>
directory in the package feeds area.
For more information, 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>
</section>
@@ -395,7 +395,7 @@
<filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename>
directory in the package feeds area.
For more information, 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>
</section>
@@ -408,7 +408,7 @@
<filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename>
directory in the package feeds area.
For more information, 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>
</section>
@@ -431,7 +431,7 @@
<para>
Locates patch files and applies them to the source code.
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#patching-dev-environment'>Patching</ulink>"
"<ulink url='&YOCTO_DOCS_OM_URL;#patching-dev-environment'>Patching</ulink>"
section in the Yocto Project Overview and Concepts Manual for more
information.
</para>
@@ -452,7 +452,7 @@
<para>
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>"
"<ulink url='&YOCTO_DOCS_OM_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>"
section in the Yocto Project Overview and Concepts Manual for more
information.
</para>
@@ -540,7 +540,7 @@
<link linkend='var-S'><filename>S</filename></link> variable also
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>"
"<ulink url='&YOCTO_DOCS_OM_URL;#source-fetching-dev-environment'>Source Fetching</ulink>"
section in the Yocto Project Overview and Concepts Manual and also
see the <filename>WORKDIR</filename> and
<filename>S</filename> variable descriptions.
@@ -620,7 +620,7 @@
<para>
Running this task does not remove the
<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>
<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink>
cache files.
Consequently, if no changes have been made and the recipe is
rebuilt after cleaning, output files are simply restored from the
@@ -637,7 +637,7 @@
<para>
Removes all output files, shared state
(<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>)
(<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink>)
cache, and downloaded source files for a target (i.e. the contents
of
<link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>).
@@ -668,13 +668,13 @@
<para>
Removes all output files and shared state
(<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>)
(<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink>)
cache for a target.
Essentially, the <filename>do_cleansstate</filename> task is
identical to the
<link linkend='ref-tasks-clean'><filename>do_clean</filename></link>
task with the added removal of shared state
(<ulink url='&YOCTO_DOCS_GS_URL;#shared-state-cache'>sstate</ulink>)
(<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink>)
cache.
</para>
@@ -744,7 +744,7 @@
<para>
Creates or updates the index in 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>
area.
<note>
This task is not triggered with the
@@ -796,7 +796,7 @@
Creates the root filesystem (file and directory structure) for an
image.
See 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 for more
information on how the root filesystem is created.
</para>