mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 00:59:48 +00:00
Code Issues Projects Releases Wiki Activity

documentation: Purged the YP Quick Start references from YP set

Browse Source 
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>
This commit is contained in:
Scott Rifenbark
2018-04-05 10:38:57 -07:00
committed by Richard Purdie
parent 097b5942ff
commit bd6580fc18
14 changed files with 66 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/concepts-manual/concepts-manual-intro.xml
+4 -3
View File
@@ -70,9 +70,10 @@
comprehension. comprehension.
For additional introductory information on the Yocto Project, see For additional introductory information on the Yocto Project, see
the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
You can find an introductory to using the Yocto Project by working If you want to build an image with no knowledge of Yocto Project
through the as a way of quickly testing it out, see the
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>
document.
</para> </para>
<para> <para>
documentation/dev-manual/dev-manual-common-tasks.xml
+2 -2
View File
@@ -4941,8 +4941,8 @@
Modifications will also disappear if you use the Modifications will also disappear if you use the
<filename>rm_work</filename> feature as described <filename>rm_work</filename> feature as described
in the in the
"<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-saving-memory-during-a-build'>Conserving Disk Space During Builds</ulink>"
section of the Yocto Project Quick Start. section.
</note> </note>
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
documentation/dev-manual/dev-manual-intro.xml
+4 -3
View File
@@ -85,9 +85,10 @@
comprehension. comprehension.
For introductory information on the Yocto Project, see the For introductory information on the Yocto Project, see the
<ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
You can find an introductory to using the Yocto Project by working If you want to build an image with no knowledge of Yocto Project
through the as a way of quickly testing it out, see the
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>
document.
</para> </para>
<para> <para>
documentation/dev-manual/dev-manual-start.xml
+6 -6
View File
@@ -733,10 +733,10 @@
the Extensible Software Development Kit (eSDK) manual. the Extensible Software Development Kit (eSDK) manual.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
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 OpenEmbedded build system, see the
"<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>
section of the Yocto Project Quick Start. document.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</note> </note>
@@ -760,9 +760,9 @@
<emphasis>Set up Your Host Development System to Support <emphasis>Set up Your Host Development System to Support
Development Using the Yocto Project</emphasis>: Development Using the Yocto Project</emphasis>:
See the See the
"<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>Setting Up to Use the Yocto Project</ulink>" "<link linkend='dev-manual-start'>Getting Started With the Yocto Project</link>"
section in the Yocto Project Quick Start for options on how section for options on how to get a build host ready to use
to get a build host ready to use the Yocto Project. the Yocto Project.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<emphasis>Initialize the Build Environment:</emphasis> <emphasis>Initialize the Build Environment:</emphasis>
documentation/getting-started/getting-started-intro.xml
+4 -3
View File
@@ -89,9 +89,10 @@
comprehension. comprehension.
For additional introductory information on the Yocto Project, see For additional introductory information on the Yocto Project, see
the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
You can find an introductory to using the Yocto Project by working If you want to build an image with no knowledge of Yocto Project
through the as a way of quickly testing it out, see the
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>
document.
</para> </para>
<para> <para>
documentation/getting-started/getting-started-yp-intro.xml
+4 -4
View File
@@ -1273,10 +1273,10 @@
<para>It is worth noting that the term "package" can, <para>It is worth noting that the term "package" can,
in general, have subtle meanings. in general, have subtle meanings.
For example, the packages referred to in the For example, the packages referred to in the
"<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
section in the Yocto Project Quick Start are compiled binaries section in the Yocto Project Reference Manual are compiled
that, when installed, add functionality to your Linux binaries that, when installed, add functionality to your
distribution.</para> Linux distribution.</para>
<para>Another point worth noting is that historically within <para>Another point worth noting is that historically within
the Yocto Project, recipes were referred to as packages - thus, the Yocto Project, recipes were referred to as packages - thus,
documentation/kernel-dev/kernel-dev-common.xml
+1 -1
View File
@@ -25,7 +25,7 @@
Before you can do any kernel development, you need to be Before you can do any kernel development, you need to be
sure your build host is set up to use the Yocto Project. sure your build host is set up to use the Yocto Project.
For information on how to get set up, see the For information on how to get set up, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Setting Up to Use the Yocto Project</ulink>" "<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>"
section in the Yocto Project Development Tasks Manual. section in the Yocto Project Development Tasks Manual.
Part of preparing the system is creating a local Git Part of preparing the system is creating a local Git
repository of the repository of the
documentation/kernel-dev/kernel-dev-intro.xml
+17 -6
View File
@@ -108,7 +108,15 @@
review and understand the following documentation: review and understand the following documentation:
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink> <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>
document.
</para></listitem>
<listitem><para>
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink>
manual.
</para></listitem>
<listitem><para>
<ulink url='&YOCTO_DOCS_CM_URL;'>Yocto Project Concepts Manual</ulink>
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<ulink url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'><filename>devtool</filename> workflow</ulink> <ulink url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'><filename>devtool</filename> workflow</ulink>
@@ -153,12 +161,15 @@
<para> <para>
<orderedlist> <orderedlist>
<listitem><para> <listitem><para>
<emphasis>Set Up Your Host Development System to Support
Development Using the Yocto Project:</emphasis>
<emphasis>Set up Your Host Development System to Support
Development Using the Yocto Project</emphasis>:
See the See the
"<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>Setting Up to Use the Yocto Project</ulink>" "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-start'>Setting Up the Development Host to Use the Yocto Project</ulink>"
section in the Yocto Project Quick Start for options on how section in the Yocto Project Development Tasks Manual for
to get a build host ready to use the Yocto Project. options on how to get a build host ready to use the Yocto
Project.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<emphasis>Set Up Your Host Development System for Kernel Development:</emphasis> <emphasis>Set Up Your Host Development System for Kernel Development:</emphasis>
documentation/ref-manual/ref-system-requirements.xml
+8 -2
View File
@@ -26,11 +26,17 @@
</para> </para>
<para> <para>
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 without having to understand concepts, work through the
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>
document.
You can find "how-to" information in the You can find "how-to" information in the
<ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink>. <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.
<note><title>Tip</title> <note><title>Tip</title>
For more information about the Yocto Project Documentation set, For more information about the Yocto Project Documentation set,
see the see the
documentation/ref-manual/ref-terms.xml
+3 -4
View File
@@ -329,10 +329,9 @@
<para>It is worth noting that the term "package" can, <para>It is worth noting that the term "package" can,
in general, have subtle meanings. in general, have subtle meanings.
For example, the packages referred to in the For example, the packages referred to in the
"<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" "<link linkend='required-packages-for-the-host-development-system'>Required Packages for the Host Development System</link>"
section in the Yocto Project Quick Start are compiled binaries section are compiled binaries that, when installed, add
that, when installed, add functionality to your Linux functionality to your Linux distribution.</para>
distribution.</para>
<para>Another point worth noting is that historically within <para>Another point worth noting is that historically within
the Yocto Project, recipes were referred to as packages - thus, the Yocto Project, recipes were referred to as packages - thus,
documentation/ref-manual/resources.xml
+4 -3
View File
@@ -160,10 +160,11 @@
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<emphasis> <emphasis>
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>: <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>:
</emphasis> </emphasis>
This short document lets you get started This short document lets you experience building an image using
with the Yocto Project and quickly begin building an image. the Yocto Project without having to understand any concepts or
details.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<emphasis> <emphasis>
documentation/sdk-manual/sdk-appendix-neon.xml
+3 -3
View File
@@ -470,9 +470,9 @@
If the architecture you need is not listed in If the architecture you need is not listed in
the menu, you will need to build the image. the menu, you will need to build the image.
See the See the
"<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-building-an-image'>Building an Image</ulink>"
section of the Yocto Project Quick Start for section of the Yocto Project Development Tasks
more information. Manual for more information.
You can also see the You can also see the
<ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>.
</para></listitem> </para></listitem>
documentation/sdk-manual/sdk-eclipse-project.xml
+3 -3
View File
@@ -708,9 +708,9 @@
in the menu, you will need to build the in the menu, you will need to build the
image. image.
See the See the
"<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-building-an-image'>Building an Image</ulink>"
section of the Yocto Project Quick Start section of the Yocto Project Development Tasks
for more information. Manual for more information.
You can also see the You can also see the
<ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>.
</para></listitem> </para></listitem>
documentation/toaster-manual/toaster-manual-start.xml
+3 -4
View File
@@ -18,10 +18,9 @@
Before you can use Toaster, you need to first set up your Before you can use Toaster, you need to first set up your
build system to run the Yocto Project. build system to run the Yocto Project.
To do this, follow the instructions in the To do this, follow the instructions in the
"<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" "<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>"
and section of the Yocto Project Development Tasks
"<ulink url='&YOCTO_DOCS_QS_URL;#releases'>Yocto Project Release</ulink>" Manual.
sections in the Yocto Project Quick Start.
For Ubuntu/Debian, you might also need to do an additional install For Ubuntu/Debian, you might also need to do an additional install
of pip3. of pip3.
<literallayout class='monospaced'> <literallayout class='monospaced'>