summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/index.rst17
-rw-r--r--documentation/dev-manual/start.rst70
-rw-r--r--documentation/overview-manual/yp-intro.rst17
-rw-r--r--documentation/ref-manual/system-requirements.rst10
4 files changed, 50 insertions, 64 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index 7ae0ddc349..100022ceba 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -25,18 +25,11 @@ build a reference embedded OS called Poky.
25 in the Yocto Project Development Tasks Manual for more 25 in the Yocto Project Development Tasks Manual for more
26 information. 26 information.
27 27
28 - You may use Windows Subsystem For Linux v2 to set up a build host 28 - You may use version 2 of Windows Subsystem For Linux (WSL 2) to set
29 using Windows 10. 29 up a build host using Windows 10 or later, Windows Server 2019 or later.
30 30 See the :ref:`dev-manual/start:setting up to use windows subsystem for
31 .. note:: 31 linux (wsl 2)` section in the Yocto Project Development Tasks Manual
32 32 for more information.
33 The Yocto Project is not compatible with WSLv1, it is
34 compatible but not officially supported nor validated with
35 WSLv2, if you still decide to use WSL please upgrade to WSLv2.
36
37 See the :ref:`dev-manual/start:setting up to use windows
38 subsystem for linux (wslv2)` section in the Yocto Project Development
39 Tasks Manual for more information.
40 33
41If you want more conceptual or background information on the Yocto 34If you want more conceptual or background information on the Yocto
42Project, see the :doc:`/overview-manual/index`. 35Project, see the :doc:`/overview-manual/index`.
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 6816ce5846..23d5643d12 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -267,16 +267,16 @@ development using the Yocto Project. Your build host can be a native
267Linux machine (recommended), it can be a machine (Linux, Mac, or 267Linux machine (recommended), it can be a machine (Linux, Mac, or
268Windows) that uses `CROPS <https://github.com/crops/poky-container>`__, 268Windows) that uses `CROPS <https://github.com/crops/poky-container>`__,
269which leverages `Docker Containers <https://www.docker.com/>`__ or it 269which leverages `Docker Containers <https://www.docker.com/>`__ or it
270can be a Windows machine capable of running Windows Subsystem For Linux 270can be a Windows machine capable of running version 2 of Windows Subsystem
271v2 (WSL). 271For Linux (WSL 2).
272 272
273.. note:: 273.. note::
274 274
275 The Yocto Project is not compatible with 275 The Yocto Project is not compatible with version 1 of
276 `Windows Subsystem for Linux v1 <https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux>`__. 276 `Windows Subsystem for Linux <https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux>`__.
277 It is compatible but not officially supported nor validated with 277 It is compatible but neither officially supported nor validated with
278 WSLv2. If you still decide to use WSL please upgrade to 278 WSL 2. If you still decide to use WSL please upgrade to
279 `WSLv2 <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`__. 279 `WSL 2 <https://learn.microsoft.com/en-us/windows/wsl/install>`__.
280 280
281Once your build host is set up to use the Yocto Project, further steps 281Once your build host is set up to use the Yocto Project, further steps
282are necessary depending on what you want to accomplish. See the 282are necessary depending on what you want to accomplish. See the
@@ -441,35 +441,36 @@ Kit (eSDK) manual. If you are going to use the Toaster container, see
441the ":doc:`/toaster-manual/setup-and-use`" 441the ":doc:`/toaster-manual/setup-and-use`"
442section in the Toaster User Manual. 442section in the Toaster User Manual.
443 443
444Setting Up to Use Windows Subsystem For Linux (WSLv2) 444Setting Up to Use Windows Subsystem For Linux (WSL 2)
445----------------------------------------------------- 445-----------------------------------------------------
446 446
447With `Windows Subsystem for Linux 447With `Windows Subsystem for Linux (WSL 2)
448(WSLv2) <https://docs.microsoft.com/en-us/windows/wsl/wsl2-about>`__, 448<https://learn.microsoft.com/en-us/windows/wsl/>`__,
449you can create a Yocto Project development environment that allows you 449you can create a Yocto Project development environment that allows you
450to build on Windows. You can set up a Linux distribution inside Windows 450to build on Windows. You can set up a Linux distribution inside Windows
451in which you can develop using the Yocto Project. 451in which you can develop using the Yocto Project.
452 452
453Follow these general steps to prepare a Windows machine using WSLv2 as 453Follow these general steps to prepare a Windows machine using WSL 2 as
454your Yocto Project build host: 454your Yocto Project build host:
455 455
4561. *Make sure your Windows 10 machine is capable of running WSLv2:* 4561. *Make sure your Windows machine is capable of running WSL 2:*
457 WSLv2 is only available for Windows 10 builds > 18917. To check which 457
458 build version you are running, you may open a command prompt on 458 While all Windows 11 and Windows Server 2022 builds support WSL 2,
459 Windows and execute the command "ver". 459 the first versions of Windows 10 and Windows Server 2019 didn't.
460 :: 460 Check the minimum build numbers for `Windows 10
461 <https://learn.microsoft.com/en-us/windows/wsl/install-manual#step-2---check-requirements-for-running-wsl-2>`__
462 and for `Windows Server 2019
463 <https://learn.microsoft.com/en-us/windows/wsl/install-on-server>`__.
464
465 To check which build version you are running, you may open a command
466 prompt on Windows and execute the command "ver"::
461 467
462 C:\Users\myuser> ver 468 C:\Users\myuser> ver
463 469
464 Microsoft Windows [Version 10.0.19041.153] 470 Microsoft Windows [Version 10.0.19041.153]
465 471
466 If your build is capable of running 4722. *Install the Linux distribution of your choice inside WSL 2:*
467 WSLv2 you may continue, for more information on this subject or 473 Once you know your version of Windows supports WSL 2, you can
468 instructions on how to upgrade to WSLv2 visit `Windows 10
469 WSLv2 <https://docs.microsoft.com/en-us/windows/wsl/wsl2-install>`__
470
4712. *Install the Linux distribution of your choice inside Windows 10:*
472 Once you know your version of Windows 10 supports WSLv2, you can
473 install the distribution of your choice from the Microsoft Store. 474 install the distribution of your choice from the Microsoft Store.
474 Open the Microsoft Store and search for Linux. While there are 475 Open the Microsoft Store and search for Linux. While there are
475 several Linux distributions available, the assumption is that your 476 several Linux distributions available, the assumption is that your
@@ -478,31 +479,28 @@ your Yocto Project build host:
478 making your selection, simply click "Get" to download and install the 479 making your selection, simply click "Get" to download and install the
479 distribution. 480 distribution.
480 481
4813. *Check your Linux distribution is using WSLv2:* Open a Windows 4823. *Check which Linux distribution WSL 2 is using:* Open a Windows
482 PowerShell and run:: 483 PowerShell and run::
483 484
484 C:\WINDOWS\system32> wsl -l -v 485 C:\WINDOWS\system32> wsl -l -v
485 NAME STATE VERSION 486 NAME STATE VERSION
486 *Ubuntu Running 2 487 *Ubuntu Running 2
487 488
488 Note the version column which says the WSL version 489 Note that WSL 2 supports running as many different Linux distributions
489 being used by your distribution, on compatible systems, this can be 490 as you want to install.
490 changed back at any point in time.
491 491
4924. *Optionally Orient Yourself on WSL:* If you are unfamiliar with WSL, 4924. *Optionally Get Familiar with WSL:* You can learn more on
493 you can learn more here -
494 https://docs.microsoft.com/en-us/windows/wsl/wsl2-about. 493 https://docs.microsoft.com/en-us/windows/wsl/wsl2-about.
495 494
4965. *Launch your WSL Distibution:* From the Windows start menu simply 4955. *Launch your WSL Distibution:* From the Windows start menu simply
497 launch your WSL distribution just like any other application. 496 launch your WSL distribution just like any other application.
498 497
4996. *Optimize your WSLv2 storage often:* Due to the way storage is 4986. *Optimize your WSL 2 storage often:* Due to the way storage is
500 handled on WSLv2, the storage space used by the underlying Linux 499 handled on WSL 2, the storage space used by the underlying Linux
501 distribution is not reflected immediately, and since BitBake heavily 500 distribution is not reflected immediately, and since BitBake heavily
502 uses storage, after several builds, you may be unaware you are 501 uses storage, after several builds, you may be unaware you are
503 running out of space. WSLv2 uses a VHDX file for storage, this issue 502 running out of space. As WSL 2 uses a VHDX file for storage, this issue
504 can be easily avoided by manually optimizing this file often, this 503 can be easily avoided by regularly optimizing this file in a manual way:
505 can be done in the following way:
506 504
507 1. *Find the location of your VHDX file:* 505 1. *Find the location of your VHDX file:*
508 506
@@ -556,14 +554,14 @@ your Yocto Project build host:
556 554
557.. note:: 555.. note::
558 556
559 The current implementation of WSLv2 does not have out-of-the-box 557 The current implementation of WSL 2 does not have out-of-the-box
560 access to external devices such as those connected through a USB 558 access to external devices such as those connected through a USB
561 port, but it automatically mounts your ``C:`` drive on ``/mnt/c/`` 559 port, but it automatically mounts your ``C:`` drive on ``/mnt/c/``
562 (and others), which you can use to share deploy artifacts to be later 560 (and others), which you can use to share deploy artifacts to be later
563 flashed on hardware through Windows, but your build directory should 561 flashed on hardware through Windows, but your build directory should
564 not reside inside this mountpoint. 562 not reside inside this mountpoint.
565 563
566Once you have WSLv2 set up, everything is in place to develop just as if 564Once you have WSL 2 set up, everything is in place to develop just as if
567you were running on a native Linux machine. If you are going to use the 565you were running on a native Linux machine. If you are going to use the
568Extensible SDK container, see the ":doc:`/sdk-manual/extensible`" Chapter in the Yocto 566Extensible SDK container, see the ":doc:`/sdk-manual/extensible`" Chapter in the Yocto
569Project Application Development and the Extensible Software Development 567Project Application Development and the Extensible Software Development
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 4e3b7c3250..8b476f43c4 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -584,20 +584,15 @@ Build Host runs, you have several choices.
584 ":ref:`dev-manual/start:setting up to use cross platforms (crops)`" 584 ":ref:`dev-manual/start:setting up to use cross platforms (crops)`"
585 section in the Yocto Project Development Tasks Manual. 585 section in the Yocto Project Development Tasks Manual.
586 586
587- *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem 587- *Windows Subsystem For Linux (WSL 2):* You may use Windows Subsystem
588 For Linux v2 to set up a Build Host using Windows 10. 588 For Linux version 2 to set up a Build Host using Windows 10 or later,
589 or Windows Server 2019 or later.
589 590
590 .. note:: 591 The Windows Subsystem For Linux allows Windows to run a real Linux
591
592 The Yocto Project is not compatible with WSLv1, it is compatible
593 but not officially supported nor validated with WSLv2, if you
594 still decide to use WSL please upgrade to WSLv2.
595
596 The Windows Subsystem For Linux allows Windows 10 to run a real Linux
597 kernel inside of a lightweight virtual machine (VM). 592 kernel inside of a lightweight virtual machine (VM).
598 593
599 For information on how to set up a Build Host with WSLv2, see the 594 For information on how to set up a Build Host with WSL 2, see the
600 ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wslv2)`" 595 ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wsl 2)`"
601 section in the Yocto Project Development Tasks Manual. 596 section in the Yocto Project Development Tasks Manual.
602 597
603- *Toaster:* Regardless of what your Build Host is running, you can use 598- *Toaster:* Regardless of what your Build Host is running, you can use
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index acc97c9d08..2a6d444040 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -74,12 +74,12 @@ distributions:
74 the supported platforms listed below. 74 the supported platforms listed below.
75 75
76 - You may use Windows Subsystem For Linux v2 to set up a build host 76 - You may use Windows Subsystem For Linux v2 to set up a build host
77 using Windows 10, but validation is not performed against build 77 using Windows 10 or later, or Windows Server 2019 or later, but validation
78 hosts using WSLv2. 78 is not performed against build hosts using WSL 2.
79 79
80 - The Yocto Project is not compatible with WSLv1, it is 80 See the
81 compatible but not officially supported nor validated with 81 :ref:`dev-manual/start:setting up to use windows subsystem for linux (wsl 2)`
82 WSLv2, if you still decide to use WSL please upgrade to WSLv2. 82 section in the Yocto Project Development Tasks Manual for more information.
83 83
84 - If you encounter problems, please go to :yocto_bugs:`Yocto Project 84 - If you encounter problems, please go to :yocto_bugs:`Yocto Project
85 Bugzilla <>` and submit a bug. We are 85 Bugzilla <>` and submit a bug. We are