summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-04-09 09:33:03 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-05-24 17:16:09 +0100
commitaa3275e9535930a7d899464514bd78aba235e3d1 (patch)
treedcf460ec7dfc17544c7e3495ec296ac2538ddb32 /documentation
parentef25f6b9502306af7c8a3ef4ac2c1d056a107005 (diff)
downloadpoky-aa3275e9535930a7d899464514bd78aba235e3d1.tar.gz
documentation: Fixed "Getting Started" manual links
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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml3
-rw-r--r--documentation/bsp-guide/bsp.xml2
-rw-r--r--documentation/concepts-manual/concepts-manual-concepts.xml2
-rw-r--r--documentation/concepts-manual/concepts-manual-intro.xml3
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml4
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml2
-rw-r--r--documentation/dev-manual/dev-manual-start.xml4
-rw-r--r--documentation/getting-started/getting-started-intro.xml2
-rw-r--r--documentation/kernel-dev/kernel-dev-concepts-appx.xml2
-rw-r--r--documentation/ref-manual/faq.xml2
-rw-r--r--documentation/ref-manual/ref-system-requirements.xml8
-rw-r--r--documentation/ref-manual/ref-terms.xml4
-rw-r--r--documentation/ref-manual/resources.xml2
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.xml2
-rw-r--r--documentation/tools/mega-manual.sed2
15 files changed, 23 insertions, 21 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
index 5cd863787c..f7e0d17d4c 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
@@ -52,7 +52,8 @@
52 <para> 52 <para>
53 If you want more conceptual or background information on the 53 If you want more conceptual or background information on the
54 Yocto Project, see the 54 Yocto Project, see the
55 <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project Manual</ulink>. 55 <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink>
56 manual.
56 </para> 57 </para>
57 </section> 58 </section>
58 59
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index ab9ac1888f..771f58c079 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -1058,7 +1058,7 @@
1058 For more information on layers, see the 1058 For more information on layers, see the
1059 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>" 1059 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
1060 section in the Getting Started With Yocto Project 1060 section in the Getting Started With Yocto Project
1061 Manual. 1061 manual.
1062 You can also reference the 1062 You can also reference the
1063 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" 1063 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
1064 section in the Yocto Project Development Tasks 1064 section in the Yocto Project Development Tasks
diff --git a/documentation/concepts-manual/concepts-manual-concepts.xml b/documentation/concepts-manual/concepts-manual-concepts.xml
index 285e1678a1..5c81863443 100644
--- a/documentation/concepts-manual/concepts-manual-concepts.xml
+++ b/documentation/concepts-manual/concepts-manual-concepts.xml
@@ -204,7 +204,7 @@
204 For more introductory information on the Yocto Project's layer 204 For more introductory information on the Yocto Project's layer
205 model, see the 205 model, see the
206 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>" 206 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
207 section in the Getting Started With Yocto Project Manual. 207 section in the Getting Started With Yocto Project manual.
208 For procedures on how to create layers, see the 208 For procedures on how to create layers, see the
209 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" 209 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
210 section in the Yocto Project Development Tasks Manual. 210 section in the Yocto Project Development Tasks Manual.
diff --git a/documentation/concepts-manual/concepts-manual-intro.xml b/documentation/concepts-manual/concepts-manual-intro.xml
index 410e9b12f7..5238a7cf06 100644
--- a/documentation/concepts-manual/concepts-manual-intro.xml
+++ b/documentation/concepts-manual/concepts-manual-intro.xml
@@ -47,7 +47,8 @@
47 <listitem><para> 47 <listitem><para>
48 <emphasis>Getting Started Material:</emphasis> 48 <emphasis>Getting Started Material:</emphasis>
49 This type of material resides in the 49 This type of material resides in the
50 <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project Manual</ulink>. 50 <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink>
51 manual.
51 </para></listitem> 52 </para></listitem>
52 <listitem><para> 53 <listitem><para>
53 <emphasis>Detailed Public Information Not Specific to the 54 <emphasis>Detailed Public Information Not Specific to the
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 175f4d4299..c2a42622a9 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -25,7 +25,7 @@
25 For introductory information on the Yocto Project Layer Model, 25 For introductory information on the Yocto Project Layer Model,
26 see the 26 see the
27 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>" 27 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
28 section in the Getting Started With Yocto Project Manual. 28 section in the Getting Started With Yocto Project manual.
29 </para> 29 </para>
30 30
31 <section id='creating-your-own-layer'> 31 <section id='creating-your-own-layer'>
@@ -1856,7 +1856,7 @@
1856 <para> 1856 <para>
1857 You can find more information about the build process in 1857 You can find more information about the build process in
1858 "<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>" 1858 "<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>"
1859 chapter of the Getting Started With Yocto Project Manual. 1859 chapter of the Getting Started With Yocto Project manual.
1860 </para> 1860 </para>
1861 </section> 1861 </section>
1862 1862
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 68c8d9bbea..0965cd5cf6 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -550,7 +550,7 @@
550 You do this by pushing to a contribution repository that is upstream. 550 You do this by pushing to a contribution repository that is upstream.
551 See the 551 See the
552 "<ulink url='&YOCTO_DOCS_GS_URL;#workflows'>Workflows</ulink>" 552 "<ulink url='&YOCTO_DOCS_GS_URL;#workflows'>Workflows</ulink>"
553 section in the Getting Started With Yocto Project Manual for additional 553 section in the Getting Started With Yocto Project manual for additional
554 concepts on working in the Yocto Project development environment. 554 concepts on working in the Yocto Project development environment.
555 </para> 555 </para>
556 556
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index de0e9a603f..91ca71c05f 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -261,12 +261,12 @@
261 For concepts and introductory information about Git as it 261 For concepts and introductory information about Git as it
262 is used in the Yocto Project, see the 262 is used in the Yocto Project, see the
263 "<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>" 263 "<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>"
264 section in the Getting Started With Yocto Project Manual. 264 section in the Getting Started With Yocto Project manual.
265 </para></listitem> 265 </para></listitem>
266 <listitem><para> 266 <listitem><para>
267 For concepts on Yocto Project source repositories, see the 267 For concepts on Yocto Project source repositories, see the
268 "<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" 268 "<ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>"
269 section in the Getting Started With Yocto Project Manual." 269 section in the Getting Started With Yocto Project manual."
270 </para></listitem> 270 </para></listitem>
271 </itemizedlist> 271 </itemizedlist>
272 </note> 272 </note>
diff --git a/documentation/getting-started/getting-started-intro.xml b/documentation/getting-started/getting-started-intro.xml
index f2fa962429..56c4fb92e9 100644
--- a/documentation/getting-started/getting-started-intro.xml
+++ b/documentation/getting-started/getting-started-intro.xml
@@ -9,7 +9,7 @@
9 <title>Welcome</title> 9 <title>Welcome</title>
10 10
11 <para> 11 <para>
12 Welcome to the Getting Started With Yocto Project Manual! 12 Welcome to the Getting Started With Yocto Project manual!
13 This manual introduces the Yocto Project by providing concepts, 13 This manual introduces the Yocto Project by providing concepts,
14 software overviews, best-known-methods (BKMs), and any other 14 software overviews, best-known-methods (BKMs), and any other
15 high-level introductory information suitable for a new Yocto 15 high-level introductory information suitable for a new Yocto
diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.xml b/documentation/kernel-dev/kernel-dev-concepts-appx.xml
index 19e9fa994a..9105f43aef 100644
--- a/documentation/kernel-dev/kernel-dev-concepts-appx.xml
+++ b/documentation/kernel-dev/kernel-dev-concepts-appx.xml
@@ -241,7 +241,7 @@
241 applies to the Yocto Project in the 241 applies to the Yocto Project in the
242 "<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>" 242 "<ulink url='&YOCTO_DOCS_GS_URL;#git'>Git</ulink>"
243 section in the Getting Started With Yocto Project 243 section in the Getting Started With Yocto Project
244 Manual. 244 manual.
245 The latter reference provides an overview of 245 The latter reference provides an overview of
246 Git and presents a minimal set of Git commands 246 Git and presents a minimal set of Git commands
247 that allows you to be functional using Git. 247 that allows you to be functional using Git.
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml
index 3c3351f4e6..394ae9bc6e 100644
--- a/documentation/ref-manual/faq.xml
+++ b/documentation/ref-manual/faq.xml
@@ -418,7 +418,7 @@
418 <para> 418 <para>
419 You can find more information on licensing in the 419 You can find more information on licensing in the
420 "<ulink url='&YOCTO_DOCS_GS_URL;#licensing'>Licensing</ulink>" 420 "<ulink url='&YOCTO_DOCS_GS_URL;#licensing'>Licensing</ulink>"
421 section in the Getting Started With Yocto Project Manual 421 section in the Getting Started With Yocto Project manual
422 and also in the 422 and also in the
423 "<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>" 423 "<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>"
424 section in the Yocto Project Development Tasks Manual. 424 section in the Yocto Project Development Tasks Manual.
diff --git a/documentation/ref-manual/ref-system-requirements.xml b/documentation/ref-manual/ref-system-requirements.xml
index f526b99090..b57ded293f 100644
--- a/documentation/ref-manual/ref-system-requirements.xml
+++ b/documentation/ref-manual/ref-system-requirements.xml
@@ -22,7 +22,7 @@
22 For introductory information on the Yocto Project, see the 22 For introductory information on the Yocto Project, see the
23 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and the 23 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and the
24 "<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>Yocto Project Development Environment</ulink>" 24 "<ulink url='&YOCTO_DOCS_GS_URL;#overview-development-environment'>Yocto Project Development Environment</ulink>"
25 chapter in the Getting Started With Yocto Project Manual. 25 chapter in the Getting Started With Yocto Project manual.
26 </para> 26 </para>
27 27
28 <para> 28 <para>
@@ -34,9 +34,9 @@
34 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink>. 34 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink>.
35 You can find getting started and concepts information in the 35 You can find getting started and concepts information in the
36 <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink> 36 <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink>
37 and 37 manual and the
38 <ulink url='&YOCTO_DOCS_CM_URL;'>Yocto Project Concepts Manual</ulink> 38 <ulink url='&YOCTO_DOCS_CM_URL;'>Yocto Project Concepts Manual</ulink>,
39 manuals, respectively. 39 respectively.
40 <note><title>Tip</title> 40 <note><title>Tip</title>
41 For more information about the Yocto Project Documentation set, 41 For more information about the Yocto Project Documentation set,
42 see the 42 see the
diff --git a/documentation/ref-manual/ref-terms.xml b/documentation/ref-manual/ref-terms.xml
index c2a23e8bf1..0984503b8c 100644
--- a/documentation/ref-manual/ref-terms.xml
+++ b/documentation/ref-manual/ref-terms.xml
@@ -246,7 +246,7 @@
246 246
247 <para>For introductory information on layers, see the 247 <para>For introductory information on layers, see the
248 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>" 248 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
249 section in the Getting Started With Yocto Project Manual. 249 section in the Getting Started With Yocto Project manual.
250 For more detailed information on layers, see the 250 For more detailed information on layers, see the
251 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" 251 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
252 section in the Yocto Project Development Tasks Manual. 252 section in the Yocto Project Development Tasks Manual.
@@ -471,7 +471,7 @@
471 <para>For more information on concepts related to Git 471 <para>For more information on concepts related to Git
472 repositories, branches, and tags, see the 472 repositories, branches, and tags, see the
473 "<ulink url='&YOCTO_DOCS_GS_URL;#repositories-tags-and-branches'>Repositories, Tags, and Branches</ulink>" 473 "<ulink url='&YOCTO_DOCS_GS_URL;#repositories-tags-and-branches'>Repositories, Tags, and Branches</ulink>"
474 section in the Getting Started With Yocto Project Manual. 474 section in the Getting Started With Yocto Project manual.
475 </para></listitem> 475 </para></listitem>
476 <listitem><para><emphasis>Task:</emphasis> 476 <listitem><para><emphasis>Task:</emphasis>
477 A unit of execution for BitBake (e.g. 477 A unit of execution for BitBake (e.g.
diff --git a/documentation/ref-manual/resources.xml b/documentation/ref-manual/resources.xml
index ac6b46e16b..7dd8d12a76 100644
--- a/documentation/ref-manual/resources.xml
+++ b/documentation/ref-manual/resources.xml
@@ -168,7 +168,7 @@
168 </para></listitem> 168 </para></listitem>
169 <listitem><para> 169 <listitem><para>
170 <emphasis> 170 <emphasis>
171 <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project Manual</ulink>: 171 <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink> Manual:
172 </emphasis> 172 </emphasis>
173 This manual introduces the Yocto Project and provides 173 This manual introduces the Yocto Project and provides
174 development environment basics. 174 development environment basics.
diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml
index 45c71bc1b1..865f40904b 100644
--- a/documentation/toaster-manual/toaster-manual-reference.xml
+++ b/documentation/toaster-manual/toaster-manual-reference.xml
@@ -93,7 +93,7 @@
93 <para> 93 <para>
94 For general information on layers, see the 94 For general information on layers, see the
95 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>" 95 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
96 section in the Getting Started With Yocto Project Manual. 96 section in the Getting Started With Yocto Project manual.
97 For information on how to create layers, see the 97 For information on how to create layers, see the
98 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" 98 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
99 section in the Yocto Project Development Tasks Manual. 99 section in the Yocto Project Development Tasks Manual.
diff --git a/documentation/tools/mega-manual.sed b/documentation/tools/mega-manual.sed
index d4ec510352..427907bcd5 100644
--- a/documentation/tools/mega-manual.sed
+++ b/documentation/tools/mega-manual.sed
@@ -28,7 +28,7 @@ s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/toaster-manual\/toaste
28s/<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 28s/<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
29s/<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 29s/<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
30s/<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 30s/<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
31s/<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 31s/<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
32s/<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 32s/<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
33s/<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 33s/<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
34s/<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 34s/<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