summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-11-16 09:38:39 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-11-22 12:20:52 +0000
commit0e91bc0a6be2e2936705cae8ff183104fba50339 (patch)
tree9542cadb2a29b628ee111bcb5d19e046703845f6 /documentation
parent58128d2b32420b788e587dfeede6cae3e5ab4476 (diff)
downloadopenembedded-core-contrib-0e91bc0a6be2e2936705cae8ff183104fba50339.tar.gz
brief-yoctoprojectqs: Added warnings about WSL, which can't be used.
Windows Subsystem for Linux (WSL) is not compatible with the Yocto Project. Added information in the beginning to note this fact to the user. (From yocto-docs rev: d8fcc0e3dc609086ca82a3419a337350f4e5c529) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml39
1 files changed, 28 insertions, 11 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
index 42dbf9c563..f8b01ecc4c 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
@@ -37,17 +37,30 @@
hardware.
You will use Yocto Project to build a reference embedded OS
called Poky.
- <note>
- The examples in this paper assume you are using a native Linux
- system running a recent Ubuntu Linux distribution.
- If the machine you want to use
- Yocto Project on to build an image is not a native Linux
- system, you can still perform these steps by using CROss
- PlatformS (CROPS) and setting up a Poky container.
- See the
- <ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-to-use-crops'>Setting Up to Use CROss PlatformS (CROPS)</ulink>"
- section in the Yocto Project Development Tasks Manual for more
- information.
+ <note><title>Notes</title>
+ <itemizedlist>
+ <listitem><para>
+ The examples in this paper assume you are using a
+ native Linux system running a recent Ubuntu Linux
+ distribution.
+ If the machine you want to use Yocto Project on to
+ build an image
+ (<ulink url='&YOCTO_DOCS_REF_URL;#hardware-build-system-term'>build host</ulink>)
+ is not a native Linux system, you can
+ still perform these steps by using CROss PlatformS
+ (CROPS) and setting up a Poky container.
+ See the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-to-use-crops'>Setting Up to Use CROss PlatformS (CROPS)</ulink>"
+ section in the Yocto Project Development Tasks Manual for more
+ information.
+ </para></listitem>
+ <listitem><para>
+ You cannot use a build host that is using the
+ <ulink url='https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux'>Windows Subsystem for Linux</ulink>
+ (WSL).
+ The Yocto Project is not compatible with WSL.
+ </para></listitem>
+ </itemizedlist>
</note>
</para>
@@ -75,6 +88,10 @@
Linux distributions that support the Yocto Project, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>"
section in the Yocto Project Reference Manual.
+ For detailed information on preparing your build host, see
+ the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-preparing-the-build-host'>Preparing the Build Host</ulink>"
+ section in the Yocto Project Development Tasks Manual.
</para></listitem>
<listitem><para>
<itemizedlist>