mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Fixed "Getting Started" manual links

Browse Source 
There was inconsistent use when referencing the getting-started
manual.  The manual's name does not include the word
"Manual".  So, I cleaned this up across the manual set and
also in the mega-manual.sed file, which was incorrectly
processing the links to that manual that do not target a
specific section.

(From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367)

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-09 09:33:03 -07:00
committed by Richard Purdie
parent ef25f6b950
commit aa3275e953
15 changed files with 23 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
View File

@@ -52,7 +52,8 @@
<para>
If you want more conceptual or background information on the
Yocto Project, see the
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project Manual</ulink>.
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink>
manual.
</para>
</section>

2
documentation/bsp-guide/bsp.xml
View File

@@ -1058,7 +1058,7 @@
For more information on layers, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
section in the Getting Started With Yocto Project
Manual.
manual.
You can also reference the
"<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
section in the Yocto Project Development Tasks

2
documentation/concepts-manual/concepts-manual-concepts.xml
View File

@@ -204,7 +204,7 @@
For more introductory information on the Yocto Project's layer
model, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
section in the Getting Started With Yocto Project Manual.
section in the Getting Started With Yocto Project manual.
For procedures on how to create layers, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
section in the Yocto Project Development Tasks Manual.

3
documentation/concepts-manual/concepts-manual-intro.xml
View File

@@ -47,7 +47,8 @@
<listitem><para>
<emphasis>Getting Started Material:</emphasis>
This type of material resides in the
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project Manual</ulink>.
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink>
manual.
</para></listitem>
<listitem><para>
<emphasis>Detailed Public Information Not Specific to the

4
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@@ -25,7 +25,7 @@
For introductory information on the Yocto Project Layer Model,
see the
"<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
section in the Getting Started With Yocto Project Manual.
section in the Getting Started With Yocto Project manual.
</para>
<section id='creating-your-own-layer'>
@@ -1856,7 +1856,7 @@
<para>
You can find more information about the build process in
"<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>"
chapter of the Getting Started With Yocto Project Manual.
chapter of the Getting Started With Yocto Project manual.
</para>
</section>

2
documentation/dev-manual/dev-manual-newbie.xml
View File

@@ -550,7 +550,7 @@
You do this by pushing to a contribution repository that is upstream.
See the
"<ulink url='&YOCTO_DOCS_GS_URL;#workflows'>Workflows</ulink>"
section in the Getting Started With Yocto Project Manual for additional
section in the Getting Started With Yocto Project manual for additional
concepts on working in the Yocto Project development environment.
</para>

4
documentation/dev-manual/dev-manual-start.xml
View File

@@ -261,12 +261,12 @@
For concepts and introductory information about Git as it
is used in the Yocto Project, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>"
section in the Getting Started With Yocto Project Manual.
section in the Getting Started With Yocto Project manual.
</para></listitem>
<listitem><para>
For concepts on Yocto Project source repositories, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
section in the Getting Started With Yocto Project Manual."
section in the Getting Started With Yocto Project manual."
</para></listitem>
</itemizedlist>
</note>

2
documentation/getting-started/getting-started-intro.xml
View File

@@ -9,7 +9,7 @@
<title>Welcome</title>
<para>
Welcome to the Getting Started With Yocto Project Manual!
Welcome to the Getting Started With Yocto Project manual!
This manual introduces the Yocto Project by providing concepts,
software overviews, best-known-methods (BKMs), and any other
high-level introductory information suitable for a new Yocto

2
documentation/kernel-dev/kernel-dev-concepts-appx.xml
View File

@@ -241,7 +241,7 @@
applies to the Yocto Project in the
"<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>"
section in the Getting Started With Yocto Project
Manual.
manual.
The latter reference provides an overview of
Git and presents a minimal set of Git commands
that allows you to be functional using Git.

2
documentation/ref-manual/faq.xml
View File

@@ -418,7 +418,7 @@
<para>
You can find more information on licensing in the
"<ulink url='&YOCTO_DOCS_GS_URL;#licensing'>Licensing</ulink>"
section in the Getting Started With Yocto Project Manual
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.

8
documentation/ref-manual/ref-system-requirements.xml
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 Getting Started With Yocto Project Manual.
chapter in the Getting Started With Yocto Project manual.
</para>
<para>
@@ -34,9 +34,9 @@
<ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink>.
You can find getting started and concepts information in the
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink>
and
<ulink url='&YOCTO_DOCS_CM_URL;'>Yocto Project Concepts Manual</ulink>
manuals, respectively.
manual and the
<ulink url='&YOCTO_DOCS_CM_URL;'>Yocto Project Concepts Manual</ulink>,
respectively.
<note><title>Tip</title>
For more information about the Yocto Project Documentation set,
see the

4
documentation/ref-manual/ref-terms.xml
View File

@@ -246,7 +246,7 @@
<para>For introductory information on layers, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
section in the Getting Started With Yocto Project Manual.
section in the Getting Started With Yocto Project manual.
For more detailed information on layers, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
section in the Yocto Project Development Tasks Manual.
@@ -471,7 +471,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 Getting Started With Yocto Project 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.

2
documentation/ref-manual/resources.xml
View File

@@ -168,7 +168,7 @@
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project Manual</ulink>:
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink> Manual:
</emphasis>
This manual introduces the Yocto Project and provides
development environment basics.

2
documentation/toaster-manual/toaster-manual-reference.xml
View File

@@ -93,7 +93,7 @@
<para>
For general information on layers, see the
"<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
section in the Getting Started With Yocto Project Manual.
section in the Getting Started With Yocto Project manual.
For information on how to create layers, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
section in the Yocto Project Development Tasks Manual.

2
documentation/tools/mega-manual.sed
View File

@@ -28,7 +28,7 @@ s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/toaster-manual\/toaste
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/brief-yoctoprojectqs\/brief-yoctoprojectqs.html" target="_top">Yocto Project Quick Build<\/a>/Yocto Project Quick Build/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/yocto-project-qs\/yocto-project-qs.html" target="_top">Yocto Project Quick Start<\/a>/Yocto Project Quick Start/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/dev-manual\/dev-manual.html" target="_top">Yocto Project Development Tasks Manual<\/a>/Yocto Project Development Tasks Manual/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/getting-started\/getting-started.html" target="_top">Getting Started With Yocto Project Manual<\/a>/Getting Started With Yocto Project Manual/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/getting-started\/getting-started.html" target="_top">Getting Started With Yocto Project<\/a>/Getting Started With Yocto Project/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/concepts-manual\/concepts-manual.html" target="_top">Yocto Project Concepts Manual<\/a>/Yocto Project Concepts Manual/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/sdk-manual\/sdk-manual.html" target="_top">Yocto Project Application Development and the Extensible Software Development Kit (eSDK)<\/a>/Yocto Project Application Development and the Extensible Software Development Kit (eSDK)/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/bsp-guide\/bsp-guide.html" target="_top">Yocto Project Board Support Package (BSP) Developer's Guide<\/a>/Yocto Project Board Support Package (BSP) Developer's Guide/g