diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-04-05 10:38:57 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-24 17:16:07 +0100 |
commit | f2242e613c6b9618bfe70c01e615a9b40a93a8e7 (patch) | |
tree | 6aee8f6e475a096a49d44cd393192c69e564d1d7 | |
parent | 35734315dde80207aaaee3cf5081dcfbc2b4bf2c (diff) | |
download | poky-f2242e613c6b9618bfe70c01e615a9b40a93a8e7.tar.gz |
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 <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/concepts-manual/concepts-manual-intro.xml | 7 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 4 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-intro.xml | 7 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 12 | ||||
-rw-r--r-- | documentation/getting-started/getting-started-intro.xml | 7 | ||||
-rw-r--r-- | documentation/getting-started/getting-started-yp-intro.xml | 8 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-common.xml | 2 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-intro.xml | 23 | ||||
-rw-r--r-- | documentation/ref-manual/ref-system-requirements.xml | 10 | ||||
-rw-r--r-- | documentation/ref-manual/ref-terms.xml | 7 | ||||
-rw-r--r-- | documentation/ref-manual/resources.xml | 7 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-appendix-neon.xml | 6 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-eclipse-project.xml | 6 | ||||
-rw-r--r-- | documentation/toaster-manual/toaster-manual-start.xml | 7 |
14 files changed, 66 insertions, 47 deletions
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 @@ | |||
70 | comprehension. | 70 | comprehension. |
71 | For additional introductory information on the Yocto Project, see | 71 | For additional introductory information on the Yocto Project, see |
72 | the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. | 72 | the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. |
73 | You can find an introductory to using the Yocto Project by working | 73 | If you want to build an image with no knowledge of Yocto Project |
74 | through the | 74 | as a way of quickly testing it out, see the |
75 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | 75 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> |
76 | document. | ||
76 | </para> | 77 | </para> |
77 | 78 | ||
78 | <para> | 79 | <para> |
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 @@ | |||
4941 | Modifications will also disappear if you use the | 4941 | Modifications will also disappear if you use the |
4942 | <filename>rm_work</filename> feature as described | 4942 | <filename>rm_work</filename> feature as described |
4943 | in the | 4943 | in the |
4944 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" | 4944 | "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-saving-memory-during-a-build'>Conserving Disk Space During Builds</ulink>" |
4945 | section of the Yocto Project Quick Start. | 4945 | section. |
4946 | </note> | 4946 | </note> |
4947 | </para></listitem> | 4947 | </para></listitem> |
4948 | <listitem><para> | 4948 | <listitem><para> |
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 @@ | |||
85 | comprehension. | 85 | comprehension. |
86 | For introductory information on the Yocto Project, see the | 86 | For introductory information on the Yocto Project, see the |
87 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. | 87 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. |
88 | You can find an introductory to using the Yocto Project by working | 88 | If you want to build an image with no knowledge of Yocto Project |
89 | through the | 89 | as a way of quickly testing it out, see the |
90 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | 90 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> |
91 | document. | ||
91 | </para> | 92 | </para> |
92 | 93 | ||
93 | <para> | 94 | <para> |
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 @@ | |||
733 | the Extensible Software Development Kit (eSDK) manual. | 733 | the Extensible Software Development Kit (eSDK) manual. |
734 | </para></listitem> | 734 | </para></listitem> |
735 | <listitem><para> | 735 | <listitem><para> |
736 | For a practical example on how to build an image using the | 736 | For a quick example on how to build an image using the |
737 | OpenEmbedded build system, see the | 737 | OpenEmbedded build system, see the |
738 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" | 738 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> |
739 | section of the Yocto Project Quick Start. | 739 | document. |
740 | </para></listitem> | 740 | </para></listitem> |
741 | </itemizedlist> | 741 | </itemizedlist> |
742 | </note> | 742 | </note> |
@@ -760,9 +760,9 @@ | |||
760 | <emphasis>Set up Your Host Development System to Support | 760 | <emphasis>Set up Your Host Development System to Support |
761 | Development Using the Yocto Project</emphasis>: | 761 | Development Using the Yocto Project</emphasis>: |
762 | See the | 762 | See the |
763 | "<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>Setting Up to Use the Yocto Project</ulink>" | 763 | "<link linkend='dev-manual-start'>Getting Started With the Yocto Project</link>" |
764 | section in the Yocto Project Quick Start for options on how | 764 | section for options on how to get a build host ready to use |
765 | to get a build host ready to use the Yocto Project. | 765 | the Yocto Project. |
766 | </para></listitem> | 766 | </para></listitem> |
767 | <listitem><para> | 767 | <listitem><para> |
768 | <emphasis>Initialize the Build Environment:</emphasis> | 768 | <emphasis>Initialize the Build Environment:</emphasis> |
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 @@ | |||
89 | comprehension. | 89 | comprehension. |
90 | For additional introductory information on the Yocto Project, see | 90 | For additional introductory information on the Yocto Project, see |
91 | the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. | 91 | the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. |
92 | You can find an introductory to using the Yocto Project by working | 92 | If you want to build an image with no knowledge of Yocto Project |
93 | through the | 93 | as a way of quickly testing it out, see the |
94 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | 94 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> |
95 | document. | ||
95 | </para> | 96 | </para> |
96 | 97 | ||
97 | <para> | 98 | <para> |
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 @@ | |||
1273 | <para>It is worth noting that the term "package" can, | 1273 | <para>It is worth noting that the term "package" can, |
1274 | in general, have subtle meanings. | 1274 | in general, have subtle meanings. |
1275 | For example, the packages referred to in the | 1275 | For example, the packages referred to in the |
1276 | "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" | 1276 | "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" |
1277 | section in the Yocto Project Quick Start are compiled binaries | 1277 | section in the Yocto Project Reference Manual are compiled |
1278 | that, when installed, add functionality to your Linux | 1278 | binaries that, when installed, add functionality to your |
1279 | distribution.</para> | 1279 | Linux distribution.</para> |
1280 | 1280 | ||
1281 | <para>Another point worth noting is that historically within | 1281 | <para>Another point worth noting is that historically within |
1282 | the Yocto Project, recipes were referred to as packages - thus, | 1282 | 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 @@ | |||
25 | Before you can do any kernel development, you need to be | 25 | Before you can do any kernel development, you need to be |
26 | sure your build host is set up to use the Yocto Project. | 26 | sure your build host is set up to use the Yocto Project. |
27 | For information on how to get set up, see the | 27 | For information on how to get set up, see the |
28 | "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Setting Up to Use the Yocto Project</ulink>" | 28 | "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Setting Up the Development Host to Use the Yocto Project</ulink>" |
29 | section in the Yocto Project Development Tasks Manual. | 29 | section in the Yocto Project Development Tasks Manual. |
30 | Part of preparing the system is creating a local Git | 30 | Part of preparing the system is creating a local Git |
31 | repository of the | 31 | 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 @@ | |||
108 | review and understand the following documentation: | 108 | review and understand the following documentation: |
109 | <itemizedlist> | 109 | <itemizedlist> |
110 | <listitem><para> | 110 | <listitem><para> |
111 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink> | 111 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> |
112 | document. | ||
113 | </para></listitem> | ||
114 | <listitem><para> | ||
115 | <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink> | ||
116 | manual. | ||
117 | </para></listitem> | ||
118 | <listitem><para> | ||
119 | <ulink url='&YOCTO_DOCS_CM_URL;'>Yocto Project Concepts Manual</ulink> | ||
112 | </para></listitem> | 120 | </para></listitem> |
113 | <listitem><para> | 121 | <listitem><para> |
114 | <ulink url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'><filename>devtool</filename> workflow</ulink> | 122 | <ulink url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'><filename>devtool</filename> workflow</ulink> |
@@ -153,12 +161,15 @@ | |||
153 | <para> | 161 | <para> |
154 | <orderedlist> | 162 | <orderedlist> |
155 | <listitem><para> | 163 | <listitem><para> |
156 | <emphasis>Set Up Your Host Development System to Support | 164 | |
157 | Development Using the Yocto Project:</emphasis> | 165 | |
166 | <emphasis>Set up Your Host Development System to Support | ||
167 | Development Using the Yocto Project</emphasis>: | ||
158 | See the | 168 | See the |
159 | "<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>Setting Up to Use the Yocto Project</ulink>" | 169 | "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-start'>Setting Up the Development Host to Use the Yocto Project</ulink>" |
160 | section in the Yocto Project Quick Start for options on how | 170 | section in the Yocto Project Development Tasks Manual for |
161 | to get a build host ready to use the Yocto Project. | 171 | options on how to get a build host ready to use the Yocto |
172 | Project. | ||
162 | </para></listitem> | 173 | </para></listitem> |
163 | <listitem><para> | 174 | <listitem><para> |
164 | <emphasis>Set Up Your Host Development System for Kernel Development:</emphasis> | 175 | <emphasis>Set Up Your Host Development System for Kernel Development:</emphasis> |
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 @@ | |||
26 | </para> | 26 | </para> |
27 | 27 | ||
28 | <para> | 28 | <para> |
29 | If you want to use the Yocto Project to test run building an image | 29 | If you want to use the Yocto Project to quickly build an image |
30 | without having to understand concepts, work through the | 30 | without having to understand concepts, work through the |
31 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | 31 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> |
32 | document. | ||
32 | You can find "how-to" information in the | 33 | You can find "how-to" information in the |
33 | <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 | ||
36 | <ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink> | ||
37 | and | ||
38 | <ulink url='&YOCTO_DOCS_CM_URL;'>Yocto Project Concepts Manual</ulink> | ||
39 | manuals, respectively. | ||
34 | <note><title>Tip</title> | 40 | <note><title>Tip</title> |
35 | For more information about the Yocto Project Documentation set, | 41 | For more information about the Yocto Project Documentation set, |
36 | see the | 42 | 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 @@ | |||
329 | <para>It is worth noting that the term "package" can, | 329 | <para>It is worth noting that the term "package" can, |
330 | in general, have subtle meanings. | 330 | in general, have subtle meanings. |
331 | For example, the packages referred to in the | 331 | For example, the packages referred to in the |
332 | "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" | 332 | "<link linkend='required-packages-for-the-host-development-system'>Required Packages for the Host Development System</link>" |
333 | section in the Yocto Project Quick Start are compiled binaries | 333 | section are compiled binaries that, when installed, add |
334 | that, when installed, add functionality to your Linux | 334 | functionality to your Linux distribution.</para> |
335 | distribution.</para> | ||
336 | 335 | ||
337 | <para>Another point worth noting is that historically within | 336 | <para>Another point worth noting is that historically within |
338 | the Yocto Project, recipes were referred to as packages - thus, | 337 | 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 @@ | |||
160 | </para></listitem> | 160 | </para></listitem> |
161 | <listitem><para> | 161 | <listitem><para> |
162 | <emphasis> | 162 | <emphasis> |
163 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>: | 163 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>: |
164 | </emphasis> | 164 | </emphasis> |
165 | This short document lets you get started | 165 | This short document lets you experience building an image using |
166 | with the Yocto Project and quickly begin building an image. | 166 | the Yocto Project without having to understand any concepts or |
167 | details. | ||
167 | </para></listitem> | 168 | </para></listitem> |
168 | <listitem><para> | 169 | <listitem><para> |
169 | <emphasis> | 170 | <emphasis> |
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 @@ | |||
470 | If the architecture you need is not listed in | 470 | If the architecture you need is not listed in |
471 | the menu, you will need to build the image. | 471 | the menu, you will need to build the image. |
472 | See the | 472 | See the |
473 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" | 473 | "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-building-an-image'>Building an Image</ulink>" |
474 | section of the Yocto Project Quick Start for | 474 | section of the Yocto Project Development Tasks |
475 | more information. | 475 | Manual for more information. |
476 | You can also see the | 476 | You can also see the |
477 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. | 477 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. |
478 | </para></listitem> | 478 | </para></listitem> |
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 @@ | |||
708 | in the menu, you will need to build the | 708 | in the menu, you will need to build the |
709 | image. | 709 | image. |
710 | See the | 710 | See the |
711 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" | 711 | "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-building-an-image'>Building an Image</ulink>" |
712 | section of the Yocto Project Quick Start | 712 | section of the Yocto Project Development Tasks |
713 | for more information. | 713 | Manual for more information. |
714 | You can also see the | 714 | You can also see the |
715 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. | 715 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. |
716 | </para></listitem> | 716 | </para></listitem> |
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 @@ | |||
18 | Before you can use Toaster, you need to first set up your | 18 | Before you can use Toaster, you need to first set up your |
19 | build system to run the Yocto Project. | 19 | build system to run the Yocto Project. |
20 | To do this, follow the instructions in the | 20 | To do this, follow the instructions in the |
21 | "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" | 21 | "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Setting Up the Development Host to Use the Yocto Project</ulink>" |
22 | and | 22 | section of the Yocto Project Development Tasks |
23 | "<ulink url='&YOCTO_DOCS_QS_URL;#releases'>Yocto Project Release</ulink>" | 23 | Manual. |
24 | sections in the Yocto Project Quick Start. | ||
25 | For Ubuntu/Debian, you might also need to do an additional install | 24 | For Ubuntu/Debian, you might also need to do an additional install |
26 | of pip3. | 25 | of pip3. |
27 | <literallayout class='monospaced'> | 26 | <literallayout class='monospaced'> |