From f2242e613c6b9618bfe70c01e615a9b40a93a8e7 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 5 Apr 2018 10:38:57 -0700 Subject: documentation: Purged the YP Quick Start references from YP set The original Yocto Project Quick Start is being retired for the YP 2.5 release (sumo). I have purged all the various references from the YP manual set and replaced them with references to the appropriate doc. The references were mainly into the YP dev-manual for setting up the host or for building an image. There were a few references into the new "Yocto Project Quick Build" document for overviewing manual-type references. (From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../concepts-manual/concepts-manual-intro.xml | 7 ++++--- .../dev-manual/dev-manual-common-tasks.xml | 4 ++-- documentation/dev-manual/dev-manual-intro.xml | 7 ++++--- documentation/dev-manual/dev-manual-start.xml | 12 +++++------ .../getting-started/getting-started-intro.xml | 7 ++++--- .../getting-started/getting-started-yp-intro.xml | 8 ++++---- documentation/kernel-dev/kernel-dev-common.xml | 2 +- documentation/kernel-dev/kernel-dev-intro.xml | 23 ++++++++++++++++------ .../ref-manual/ref-system-requirements.xml | 10 ++++++++-- documentation/ref-manual/ref-terms.xml | 7 +++---- documentation/ref-manual/resources.xml | 7 ++++--- documentation/sdk-manual/sdk-appendix-neon.xml | 6 +++--- documentation/sdk-manual/sdk-eclipse-project.xml | 6 +++--- .../toaster-manual/toaster-manual-start.xml | 7 +++---- 14 files changed, 66 insertions(+), 47 deletions(-) (limited to 'documentation') diff --git a/documentation/concepts-manual/concepts-manual-intro.xml b/documentation/concepts-manual/concepts-manual-intro.xml index adaa612525..410e9b12f7 100644 --- a/documentation/concepts-manual/concepts-manual-intro.xml +++ b/documentation/concepts-manual/concepts-manual-intro.xml @@ -70,9 +70,10 @@ comprehension. For additional introductory information on the Yocto Project, see the Yocto Project Website. - You can find an introductory to using the Yocto Project by working - through the - Yocto Project Quick Start. + If you want to build an image with no knowledge of Yocto Project + as a way of quickly testing it out, see the + Yocto Project Quick Build + document. diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 4fdcb7b780..d07b290aa7 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -4941,8 +4941,8 @@ Modifications will also disappear if you use the rm_work feature as described in the - "Building Images" - section of the Yocto Project Quick Start. + "Conserving Disk Space During Builds" + section. diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index 47c80061be..d8f4466391 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml @@ -85,9 +85,10 @@ comprehension. For introductory information on the Yocto Project, see the Yocto Project Website. - You can find an introductory to using the Yocto Project by working - through the - Yocto Project Quick Start. + If you want to build an image with no knowledge of Yocto Project + as a way of quickly testing it out, see the + Yocto Project Quick Build + document. diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 7732fdfb74..de0e9a603f 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -733,10 +733,10 @@ the Extensible Software Development Kit (eSDK) manual. - For a practical example on how to build an image using the + For a quick example on how to build an image using the OpenEmbedded build system, see the - "Building Images" - section of the Yocto Project Quick Start. + Yocto Project Quick Build + document. @@ -760,9 +760,9 @@ Set up Your Host Development System to Support Development Using the Yocto Project: See the - "Setting Up to Use the Yocto Project" - section in the Yocto Project Quick Start for options on how - to get a build host ready to use the Yocto Project. + "Getting Started With the Yocto Project" + section for options on how to get a build host ready to use + the Yocto Project. Initialize the Build Environment: diff --git a/documentation/getting-started/getting-started-intro.xml b/documentation/getting-started/getting-started-intro.xml index e5967b34e4..f2fa962429 100644 --- a/documentation/getting-started/getting-started-intro.xml +++ b/documentation/getting-started/getting-started-intro.xml @@ -89,9 +89,10 @@ comprehension. For additional introductory information on the Yocto Project, see the Yocto Project Website. - You can find an introductory to using the Yocto Project by working - through the - Yocto Project Quick Start. + If you want to build an image with no knowledge of Yocto Project + as a way of quickly testing it out, see the + Yocto Project Quick Build + document. diff --git a/documentation/getting-started/getting-started-yp-intro.xml b/documentation/getting-started/getting-started-yp-intro.xml index 6941db68b9..96bab66dff 100644 --- a/documentation/getting-started/getting-started-yp-intro.xml +++ b/documentation/getting-started/getting-started-yp-intro.xml @@ -1273,10 +1273,10 @@ It is worth noting that the term "package" can, in general, have subtle meanings. For example, the packages referred to in the - "The Build Host Packages" - section in the Yocto Project Quick Start are compiled binaries - that, when installed, add functionality to your Linux - distribution. + "Required Packages for the Host Development System" + section in the Yocto Project Reference Manual are compiled + binaries that, when installed, add functionality to your + Linux distribution. Another point worth noting is that historically within the Yocto Project, recipes were referred to as packages - thus, diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index 9686609bf5..d8eeb9ec50 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml @@ -25,7 +25,7 @@ Before you can do any kernel development, you need to be sure your build host is set up to use the Yocto Project. For information on how to get set up, see the - "Setting Up to Use the Yocto Project" + "Setting Up the Development Host to Use the Yocto Project" section in the Yocto Project Development Tasks Manual. Part of preparing the system is creating a local Git repository of the diff --git a/documentation/kernel-dev/kernel-dev-intro.xml b/documentation/kernel-dev/kernel-dev-intro.xml index 7a5a34deb1..f61af3104d 100644 --- a/documentation/kernel-dev/kernel-dev-intro.xml +++ b/documentation/kernel-dev/kernel-dev-intro.xml @@ -108,7 +108,15 @@ review and understand the following documentation: - Yocto Project Quick Start + Yocto Project Quick Build + document. + + + Getting Started With Yocto Project + manual. + + + Yocto Project Concepts Manual devtool workflow @@ -153,12 +161,15 @@ - Set Up Your Host Development System to Support - Development Using the Yocto Project: + + + Set up Your Host Development System to Support + Development Using the Yocto Project: See the - "Setting Up to Use the Yocto Project" - section in the Yocto Project Quick Start for options on how - to get a build host ready to use the Yocto Project. + "Setting Up the Development Host to Use the Yocto Project" + section in the Yocto Project Development Tasks Manual for + options on how to get a build host ready to use the Yocto + Project. Set Up Your Host Development System for Kernel Development: diff --git a/documentation/ref-manual/ref-system-requirements.xml b/documentation/ref-manual/ref-system-requirements.xml index 423c7389d7..f526b99090 100644 --- a/documentation/ref-manual/ref-system-requirements.xml +++ b/documentation/ref-manual/ref-system-requirements.xml @@ -26,11 +26,17 @@ - If you want to use the Yocto Project to test run building an image + If you want to use the Yocto Project to quickly build an image without having to understand concepts, work through the - Yocto Project Quick Start. + Yocto Project Quick Build + document. You can find "how-to" information in the 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. 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 b8320dbfd6..4681066f89 100644 --- a/documentation/ref-manual/ref-terms.xml +++ b/documentation/ref-manual/ref-terms.xml @@ -329,10 +329,9 @@ It is worth noting that the term "package" can, in general, have subtle meanings. For example, the packages referred to in the - "The Build Host Packages" - section in the Yocto Project Quick Start are compiled binaries - that, when installed, add functionality to your Linux - distribution. + "Required Packages for the Host Development System" + section are compiled binaries that, when installed, add + functionality to your Linux distribution. Another point worth noting is that historically within the Yocto Project, recipes were referred to as packages - thus, diff --git a/documentation/ref-manual/resources.xml b/documentation/ref-manual/resources.xml index 9ad4d2eaa9..8e76ccc3ef 100644 --- a/documentation/ref-manual/resources.xml +++ b/documentation/ref-manual/resources.xml @@ -160,10 +160,11 @@ - Yocto Project Quick Start: + Yocto Project Quick Build: - This short document lets you get started - with the Yocto Project and quickly begin building an image. + This short document lets you experience building an image using + the Yocto Project without having to understand any concepts or + details. diff --git a/documentation/sdk-manual/sdk-appendix-neon.xml b/documentation/sdk-manual/sdk-appendix-neon.xml index ca6198cadc..268a73090f 100644 --- a/documentation/sdk-manual/sdk-appendix-neon.xml +++ b/documentation/sdk-manual/sdk-appendix-neon.xml @@ -470,9 +470,9 @@ If the architecture you need is not listed in the menu, you will need to build the image. See the - "Building Images" - section of the Yocto Project Quick Start for - more information. + "Building an Image" + section of the Yocto Project Development Tasks + Manual for more information. You can also see the wiki. diff --git a/documentation/sdk-manual/sdk-eclipse-project.xml b/documentation/sdk-manual/sdk-eclipse-project.xml index e1bf522bc9..c5aa947f6d 100644 --- a/documentation/sdk-manual/sdk-eclipse-project.xml +++ b/documentation/sdk-manual/sdk-eclipse-project.xml @@ -708,9 +708,9 @@ in the menu, you will need to build the image. See the - "Building Images" - section of the Yocto Project Quick Start - for more information. + "Building an Image" + section of the Yocto Project Development Tasks + Manual for more information. You can also see the wiki. diff --git a/documentation/toaster-manual/toaster-manual-start.xml b/documentation/toaster-manual/toaster-manual-start.xml index 65e057a83e..cf51f416e7 100644 --- a/documentation/toaster-manual/toaster-manual-start.xml +++ b/documentation/toaster-manual/toaster-manual-start.xml @@ -18,10 +18,9 @@ Before you can use Toaster, you need to first set up your build system to run the Yocto Project. To do this, follow the instructions in the - "The Build Host Packages" - and - "Yocto Project Release" - sections in the Yocto Project Quick Start. + "Setting Up the Development Host to Use the Yocto Project" + section of the Yocto Project Development Tasks + Manual. For Ubuntu/Debian, you might also need to do an additional install of pip3. -- cgit v1.2.3-54-g00ecf