summaryrefslogtreecommitdiffstats
path: root/external/poky/documentation/overview-manual
diff options
context:
space:
mode:
authortakeshi_hoshina <takeshi_hoshina@mail.toyota.co.jp>2020-11-02 11:07:33 +0900
committertakeshi_hoshina <takeshi_hoshina@mail.toyota.co.jp>2020-11-02 11:07:33 +0900
commit1c7d6584a7811b7785ae5c1e378f14b5ba0971cf (patch)
treecd70a267a5ef105ba32f200aa088e281fbd85747 /external/poky/documentation/overview-manual
parent4204309872da5cb401cbb2729d9e2d4869a87f42 (diff)
recipes
Diffstat (limited to 'external/poky/documentation/overview-manual')
-rwxr-xr-x[-rw-r--r--]external/poky/documentation/overview-manual/figures/index-downloads.pngbin36362 -> 18142 bytes
-rw-r--r--external/poky/documentation/overview-manual/overview-manual-concepts.xml15
-rw-r--r--external/poky/documentation/overview-manual/overview-manual-development-environment.xml27
-rw-r--r--external/poky/documentation/overview-manual/overview-manual-eclipse-customization.xsl35
-rw-r--r--external/poky/documentation/overview-manual/overview-manual-yp-intro.xml69
-rwxr-xr-x[-rw-r--r--]external/poky/documentation/overview-manual/overview-manual.xml52
6 files changed, 65 insertions, 133 deletions
diff --git a/external/poky/documentation/overview-manual/figures/index-downloads.png b/external/poky/documentation/overview-manual/figures/index-downloads.png
index 96303b87..d8d4475c 100644..100755
--- a/external/poky/documentation/overview-manual/figures/index-downloads.png
+++ b/external/poky/documentation/overview-manual/figures/index-downloads.png
Binary files differ
diff --git a/external/poky/documentation/overview-manual/overview-manual-concepts.xml b/external/poky/documentation/overview-manual/overview-manual-concepts.xml
index 064c235a..f085dd71 100644
--- a/external/poky/documentation/overview-manual/overview-manual-concepts.xml
+++ b/external/poky/documentation/overview-manual/overview-manual-concepts.xml
@@ -82,7 +82,7 @@
<para>
This section briefly introduces BitBake.
If you want more information on BitBake, see the
- <ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual'>BitBake User Manual</ulink>.
+ <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>.
</para>
<para>
@@ -924,9 +924,12 @@
<title>Source Control Managers (Optional)</title>
<para>
- Another place the build system can get source files from is
- through an SCM such as Git or Subversion.
- In this case, a repository is cloned or checked out.
+ Another place from which the build system can get source
+ files is with
+ <ulink url='&YOCTO_DOCS_BB_URL;#bb-fetchers'>fetchers</ulink>
+ employing various Source Control Managers (SCMs) such as
+ Git or Subversion.
+ In such cases, a repository is cloned or checked out.
The
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink>
task inside BitBake uses
@@ -940,7 +943,7 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink>
directory, see the
<ulink url='&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></ulink>
- variable.
+ variable in the Yocto Project Reference Manual.
</note>
</para>
@@ -1091,7 +1094,7 @@
<note>
Separate documentation exists for the BitBake tool.
See the
- <ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual'>BitBake User Manual</ulink>
+ <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>
for reference material on BitBake.
</note>
</para>
diff --git a/external/poky/documentation/overview-manual/overview-manual-development-environment.xml b/external/poky/documentation/overview-manual/overview-manual-development-environment.xml
index bba93cce..36ebf8a3 100644
--- a/external/poky/documentation/overview-manual/overview-manual-development-environment.xml
+++ b/external/poky/documentation/overview-manual/overview-manual-development-environment.xml
@@ -87,7 +87,7 @@
as its operating system as your development host.
When you have a Mac or Windows-based system, you can set it up
as the development host by using
- <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink>,
+ <ulink url='https://github.com/crops/poky-container'>CROPS</ulink>,
which leverages
<ulink url='https://www.docker.com/'>Docker Containers</ulink>.
Once you take the steps to set up a CROPS machine, you effectively
@@ -166,22 +166,6 @@
section in the Yocto Project Linux Kernel Development Manual.
</para></listitem>
<listitem><para>
- <emphasis>Using the <trademark class='trade'>Eclipse</trademark> IDE:</emphasis>
- One of two Yocto Project development methods that involves an
- interface that effectively puts the Yocto Project into the
- background is the popular Eclipse IDE.
- This method of development is advantageous if you are already
- familiar with working within Eclipse.
- Development is supported through a plugin that you install
- onto your development host.</para>
-
- <para>For steps that show you how to set up your development
- host to use the Eclipse Yocto Project plugin, see the
- "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-eclipse-project'>Developing Applications Using <trademark class='trade'>Eclipse</trademark></ulink>"
- Chapter in the Yocto Project Application Development and the
- Extensible Software Development Kit (eSDK) manual.
- </para></listitem>
- <listitem><para>
<emphasis>Using Toaster:</emphasis>
The other Yocto Project development method that involves an
interface that effectively puts the Yocto Project into the
@@ -276,11 +260,10 @@
<emphasis>
<ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink>
</emphasis>
- This is an index of releases such as
- the <trademark class='trade'>Eclipse</trademark>
- Yocto Plug-in, miscellaneous support, Poky, Pseudo, installers
- for cross-development toolchains, and all released versions of
- Yocto Project in the form of images or tarballs.
+ This is an index of releases such as Poky, Pseudo, installers
+ for cross-development toolchains, miscellaneous support
+ and all released versions of Yocto Project in the form of
+ images or tarballs.
Downloading and extracting these files does not produce a local
copy of the Git repository but rather a snapshot of a
particular release or image.</para>
diff --git a/external/poky/documentation/overview-manual/overview-manual-eclipse-customization.xsl b/external/poky/documentation/overview-manual/overview-manual-eclipse-customization.xsl
deleted file mode 100644
index aaf99ea1..00000000
--- a/external/poky/documentation/overview-manual/overview-manual-eclipse-customization.xsl
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version='1.0'?>
-<xsl:stylesheet
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- xmlns="http://www.w3.org/1999/xhtml"
- xmlns:fo="http://www.w3.org/1999/XSL/Format"
- version="1.0">
-
- <xsl:import href="http://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" />
-
-<!--
-
- <xsl:import href="../template/1.76.1/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" />
-
- <xsl:import
- href="http://docbook.sourceforge.net/release/xsl/1.76.1/eclipse/eclipse3.xsl" />
-
--->
-
- <xsl:param name="chunker.output.indent" select="'yes'"/>
- <xsl:param name="chunk.quietly" select="1"/>
- <xsl:param name="chunk.first.sections" select="1"/>
- <xsl:param name="chunk.section.depth" select="10"/>
- <xsl:param name="use.id.as.filename" select="1"/>
- <xsl:param name="ulink.target" select="'_self'" />
- <xsl:param name="base.dir" select="'html/overview-manual/'"/>
- <xsl:param name="html.stylesheet" select="'../book.css'"/>
- <xsl:param name="eclipse.manifest" select="0"/>
- <xsl:param name="create.plugin.xml" select="0"/>
- <xsl:param name="suppress.navigation" select="1"/>
- <xsl:param name="generate.index" select="0"/>
- <xsl:param name="chapter.autolabel" select="1" />
- <xsl:param name="appendix.autolabel" select="1" />
- <xsl:param name="section.autolabel" select="1" />
- <xsl:param name="section.label.includes.component.label" select="1" />
-</xsl:stylesheet>
diff --git a/external/poky/documentation/overview-manual/overview-manual-yp-intro.xml b/external/poky/documentation/overview-manual/overview-manual-yp-intro.xml
index 254f191c..1b60a303 100644
--- a/external/poky/documentation/overview-manual/overview-manual-yp-intro.xml
+++ b/external/poky/documentation/overview-manual/overview-manual-yp-intro.xml
@@ -225,9 +225,9 @@
For information that helps you transition from
trying out the Yocto Project to using it for your
project, see the
- "<ulink url='&YOCTO_HOME_URL;/docs/what-i-wish-id-known/'>What I wish I'd Known</ulink>"
+ "<ulink url='&YOCTO_DOCS_URL;/what-i-wish-id-known/'>What I wish I'd Known</ulink>"
and
- "<ulink url='&YOCTO_HOME_URL;/docs/transitioning-to-a-custom-environment/'>Transitioning to a Custom Environment for Systems Development</ulink>"
+ "<ulink url='&YOCTO_DOCS_URL;/transitioning-to-a-custom-environment/'>Transitioning to a Custom Environment for Systems Development</ulink>"
documents on the Yocto Project website.
</para></listitem>
<listitem><para>
@@ -437,7 +437,7 @@
<itemizedlist>
<listitem><para id='gs-crops-overview'>
<emphasis>CROPS:</emphasis>
- <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink>
+ <ulink url='https://github.com/crops/poky-container/'>CROPS</ulink>
is an open source, cross-platform development framework
that leverages
<ulink url='https://www.docker.com/'>Docker Containers</ulink>.
@@ -502,35 +502,6 @@
Manual.
</para></listitem>
<listitem><para>
- <emphasis><trademark class='trade'>Eclipse</trademark> IDE Plug-in:</emphasis>
- This plug-in enables you to use the popular Eclipse
- Integrated Development Environment (IDE), which allows
- for development using the Yocto Project all within the
- Eclipse IDE.
- You can work within Eclipse to cross-compile, deploy,
- and execute your output into a QEMU emulation session
- as well as onto actual target hardware.</para>
-
- <para>The environment also supports performance
- enhancing tools that allow you to perform remote
- profiling, tracing, collection of power data,
- collection of latency data, and collection of
- performance data.</para>
-
- <para>Once you enable the plug-in, standard Eclipse
- functions automatically use the cross-toolchain
- and target system libraries.
- You can build applications using any of these
- libraries.</para>
-
- <para>For more information on the Eclipse plug-in,
- see the
- "<ulink url='&YOCTO_DOCS_SDK_URL;#adt-eclipse'>Working Within Eclipse</ulink>"
- section in the Yocto Project Application Development
- and the Extensible Software Development Kit (eSDK)
- manual.
- </para></listitem>
- <listitem><para>
<emphasis>Toaster:</emphasis>
Toaster is a web interface to the Yocto Project
OpenEmbedded build system.
@@ -912,7 +883,7 @@
<listitem><para>
<emphasis>CROss PlatformS (CROPS):</emphasis>
Typically, you use
- <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink>,
+ <ulink url='https://github.com/crops/poky-container/'>CROPS</ulink>,
which leverages
<ulink url='https://www.docker.com/'>Docker Containers</ulink>,
to set up a Build Host that is not running Linux (e.g.
@@ -937,6 +908,24 @@
section in the Yocto Project Development Tasks Manual.
</para></listitem>
<listitem><para>
+ <emphasis>Windows Subsystem For Linux (WSLv2):</emphasis>
+ You may use Windows Subsystem For Linux v2 to set up a build
+ host using Windows 10.
+ <note>
+ The Yocto Project is not compatible with WSLv1, it is
+ compatible but not officially supported nor validated
+ with WSLv2, if you still decide to use WSL please upgrade
+ to WSLv2.
+ </note>
+ The Windows Subsystem For Linux allows Windows 10 to run a real
+ Linux kernel inside of a lightweight utility virtual
+ machine (VM) using virtualization technology.</para>
+ <para>For information on how to set up a Build Host with
+ WSLv2, see the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-to-use-wsl'>Setting Up to Use Windows Subsystem For Linux</ulink>"
+ section in the Yocto Project Development Tasks Manual.
+ </para></listitem>
+ <listitem><para>
<emphasis>Toaster:</emphasis>
Regardless of what your Build Host is running, you can
use Toaster to develop software using the Yocto Project.
@@ -953,20 +942,6 @@
see the
<ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>.
</para></listitem>
- <listitem><para>
- <emphasis><trademark class='trade'>Eclipse</trademark> IDE:</emphasis>
- If your Build Host supports and runs the popular
- Eclipse IDE, you can install the Yocto Project Eclipse
- plug-in and use the Yocto Project to develop software.
- The plug-in integrates the Yocto Project functionality
- into Eclipse development practices.</para>
-
- <para>For information about how to install and use the
- Yocto Project Eclipse plug-in, see the
- "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-eclipse-project'>Developing Applications Using Eclipse</ulink>"
- chapter in the Yocto Project Application Development and
- the Extensible Software Development Kit (eSDK) Manual.
- </para></listitem>
</itemizedlist>
</para>
</section>
diff --git a/external/poky/documentation/overview-manual/overview-manual.xml b/external/poky/documentation/overview-manual/overview-manual.xml
index e79867ec..771eca07 100644..100755
--- a/external/poky/documentation/overview-manual/overview-manual.xml
+++ b/external/poky/documentation/overview-manual/overview-manual.xml
@@ -22,11 +22,10 @@
<authorgroup>
<author>
- <firstname>Scott</firstname> <surname>Rifenbark</surname>
<affiliation>
- <orgname>Scotty's Documentation Services, INC</orgname>
+ <orgname>&ORGNAME;</orgname>
</affiliation>
- <email>srifenbark@gmail.com</email>
+ <email>&ORGEMAIL;</email>
</author>
</authorgroup>
@@ -42,24 +41,29 @@
<revremark>Released with the Yocto Project 2.6 Release.</revremark>
</revision>
<revision>
- <revnumber>2.6.1</revnumber>
- <date>February 2019</date>
- <revremark>Released with the Yocto Project 2.6.1 Release.</revremark>
+ <revnumber>2.7</revnumber>
+ <date>May 2019</date>
+ <revremark>Released with the Yocto Project 2.7 Release.</revremark>
</revision>
<revision>
- <revnumber>2.6.2</revnumber>
- <date>April 2019</date>
- <revremark>Released with the Yocto Project 2.6.2 Release.</revremark>
+ <revnumber>3.0</revnumber>
+ <date>October 2019</date>
+ <revremark>Released with the Yocto Project 3.0 Release.</revremark>
</revision>
<revision>
- <revnumber>2.6.3</revnumber>
- <date>August 2019</date>
- <revremark>Released with the Yocto Project 2.6.3 Release.</revremark>
+ <revnumber>3.1</revnumber>
+ <date>April 2020</date>
+ <revremark>Released with the Yocto Project 3.1 Release.</revremark>
</revision>
<revision>
- <revnumber>2.6.4</revnumber>
- <date>November 2019</date>
- <revremark>Released with the Yocto Project 2.6.4 Release.</revremark>
+ <revnumber>3.1.1</revnumber>
+ <date>June 2020</date>
+ <revremark>Released with the Yocto Project 3.1.1 Release.</revremark>
+ </revision>
+ <revision>
+ <revnumber>3.1.2</revnumber>
+ <date>&REL_MONTH_YEAR;</date>
+ <revremark>Released with the Yocto Project 3.1.2 Release.</revremark>
</revision>
</revhistory>
@@ -84,7 +88,7 @@
Yocto Project.
To be sure you have the latest version of the manual
for this release, go to the
- <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
+ <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
@@ -101,18 +105,20 @@
page.
If you need a version of this manual for a different
Yocto Project release, visit the
- <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
+ <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
pull-down menus.
</para></listitem>
- <listitem><para>
+ <listitem>
+ <para>
To report any inaccuracies or problems with this
- manual, send an email to the Yocto Project
- discussion group at
- <filename>yocto@yoctoproject.com</filename> or log into
- the freenode <filename>#yocto</filename> channel.
- </para></listitem>
+ (or any other Yocto Project) manual, send an email to
+ the Yocto Project documentation mailing list at
+ <filename>docs@lists.yoctoproject.org</filename> or
+ log into the freenode <filename>#yocto</filename> channel.
+ </para>
+ </listitem>
</itemizedlist>
</note>
</legalnotice>