From 39810ff50509dcb90565f9b432c555f336f23604 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 9 Apr 2018 09:33:03 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml | 3 ++- documentation/bsp-guide/bsp.xml | 2 +- documentation/concepts-manual/concepts-manual-concepts.xml | 2 +- documentation/concepts-manual/concepts-manual-intro.xml | 3 ++- documentation/dev-manual/dev-manual-common-tasks.xml | 4 ++-- documentation/dev-manual/dev-manual-newbie.xml | 2 +- documentation/dev-manual/dev-manual-start.xml | 4 ++-- documentation/getting-started/getting-started-intro.xml | 2 +- documentation/kernel-dev/kernel-dev-concepts-appx.xml | 2 +- documentation/ref-manual/faq.xml | 2 +- documentation/ref-manual/ref-system-requirements.xml | 8 ++++---- documentation/ref-manual/ref-terms.xml | 4 ++-- documentation/ref-manual/resources.xml | 2 +- documentation/toaster-manual/toaster-manual-reference.xml | 2 +- documentation/tools/mega-manual.sed | 2 +- 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 @@ If you want more conceptual or background information on the Yocto Project, see the - Getting Started With Yocto Project Manual. + Getting Started With Yocto Project + manual. 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 @@ For more information on layers, see the "The Yocto Project Layer Model" section in the Getting Started With Yocto Project - Manual. + manual. You can also reference the "Understanding and Creating Layers" 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 @@ For more introductory information on the Yocto Project's layer model, see the "The Yocto Project Layer Model" - 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 "Understanding and Creating Layers" 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 @@ Getting Started Material: This type of material resides in the - Getting Started With Yocto Project Manual. + Getting Started With Yocto Project + manual. 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 @@ For introductory information on the Yocto Project Layer Model, see the "The Yocto Project Layer Model" - section in the Getting Started With Yocto Project Manual. + section in the Getting Started With Yocto Project manual.
@@ -1856,7 +1856,7 @@ You can find more information about the build process in "The Yocto Project Development Environment" - chapter of the Getting Started With Yocto Project Manual. + chapter of the Getting Started With Yocto Project manual.
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 @@ You do this by pushing to a contribution repository that is upstream. See the "Workflows" - 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. 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 @@ For concepts and introductory information about Git as it is used in the Yocto Project, see the "Git" - section in the Getting Started With Yocto Project Manual. + section in the Getting Started With Yocto Project manual. For concepts on Yocto Project source repositories, see the "Yocto Project Source Repositories" - section in the Getting Started With Yocto Project Manual." + section in the Getting Started With Yocto Project manual." 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 @@ Welcome - 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 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 @@ applies to the Yocto Project in the "Git" 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. 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 @@ You can find more information on licensing in the "Licensing" - section in the Getting Started With Yocto Project Manual + section in the Getting Started With Yocto Project manual and also in the "Maintaining Open Source License Compliance During Your Product's Lifecycle" 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 @@ For introductory information on the Yocto Project, see the Yocto Project Website and the "Yocto Project Development Environment" - chapter in the Getting Started With Yocto Project Manual. + chapter in the Getting Started With Yocto Project manual. @@ -34,9 +34,9 @@ Yocto Project Development Tasks Manual. You can find getting started and concepts information in the Getting Started With Yocto Project - and - Yocto Project Concepts Manual - manuals, respectively. + manual and the + Yocto Project Concepts Manual, + respectively. Tip For more information about the Yocto Project Documentation set, 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 @@ For introductory information on layers, see the "The Yocto Project Layer Model" - 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 "Understanding and Creating Layers" section in the Yocto Project Development Tasks Manual. @@ -471,7 +471,7 @@ For more information on concepts related to Git repositories, branches, and tags, see the "Repositories, Tags, and Branches" - section in the Getting Started With Yocto Project Manual. + section in the Getting Started With Yocto Project manual. Task: 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 @@ - Getting Started With Yocto Project Manual: + Getting Started With Yocto Project Manual: This manual introduces the Yocto Project and provides 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 @@ For general information on layers, see the "The Yocto Project Layer Model" - 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 "Understanding and Creating Layers" 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 s/Yocto Project Quick Build<\/a>/Yocto Project Quick Build/g s/Yocto Project Quick Start<\/a>/Yocto Project Quick Start/g s/Yocto Project Development Tasks Manual<\/a>/Yocto Project Development Tasks Manual/g -s/Getting Started With Yocto Project Manual<\/a>/Getting Started With Yocto Project Manual/g +s/Getting Started With Yocto Project<\/a>/Getting Started With Yocto Project/g s/Yocto Project Concepts Manual<\/a>/Yocto Project Concepts Manual/g s/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/Yocto Project Board Support Package (BSP) Developer's Guide<\/a>/Yocto Project Board Support Package (BSP) Developer's Guide/g -- cgit v1.2.3-54-g00ecf