Skip to contentSkip to conversation

manuals: updates for building on Windows (WSL 2)

PATCH Superseded [email protected] 2 participants 3 messages Oct 19, 2022 – Oct 20, 2022

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 manuals: updates for building on Windows (WSL 2)

From: Michael Opdenacker <[email protected]>

- Use the Wikipedia naming scheme: WSL 2 instead of WSLv2
- Take into account Windows Server 2019 and 2022 which are supported too.
- Improve some explanations

---
 documentation/brief-yoctoprojectqs/index.rst  | 17 ++---
 documentation/dev-manual/start.rst            | 70 +++++++++----------
 documentation/overview-manual/yp-intro.rst    | 17 ++---
 .../ref-manual/system-requirements.rst        | 10 +--
 4 files changed, 50 insertions(+), 64 deletions(-)
documentation/brief-yoctoprojectqs/index.rst +5 -12
index 7ae0ddc349..0dfb4cc7ff 100644
@@ -25,18 +25,11 @@ build a reference embedded OS called Poky.
       in the Yocto Project Development Tasks Manual for more
       information.
 
-   -  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.
-
-      See the :ref:`dev-manual/start:setting up to use windows
-      subsystem for linux (wslv2)` section in the Yocto Project Development
-      Tasks Manual for more information.
+   -  You may use version 2 of Windows Subsystem For Linux (WSL 2) to set
+      up a build host using Windows 10 or 11 or Windows Server 2019 or 2022.
+      See the :ref:`dev-manual/start:setting up to use windows subsystem for
+      linux (wsl 2)` section in the Yocto Project Development Tasks Manual
+      for more information.
 
 If you want more conceptual or background information on the Yocto
 Project, see the :doc:`/overview-manual/index`.
documentation/dev-manual/start.rst +34 -36

130 lines not on this page · raw message

documentation/overview-manual/yp-intro.rst +6 -11
index 4e3b7c3250..6293f428f9 100644
@@ -584,20 +584,15 @@ Build Host runs, you have several choices.
    ":ref:`dev-manual/start:setting up to use cross platforms (crops)`"
    section in the Yocto Project Development Tasks Manual.
 
--  *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem
-   For Linux v2 to set up a Build Host using Windows 10.
+-  *Windows Subsystem For Linux (WSL 2):* You may use Windows Subsystem
+   For Linux version 2 to set up a Build Host using Windows 10 or 11,
+   or Windows Server 2019 or 2022.
 
-   .. 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.
-
-   The Windows Subsystem For Linux allows Windows 10 to run a real Linux
+   The Windows Subsystem For Linux allows Windows to run a real Linux
    kernel inside of a lightweight virtual machine (VM).
 
-   For information on how to set up a Build Host with WSLv2, see the
-   ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wslv2)`"
+   For information on how to set up a Build Host with WSL 2, see the
+   ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wsl 2)`"
    section in the Yocto Project Development Tasks Manual.
 
 -  *Toaster:* Regardless of what your Build Host is running, you can use
documentation/ref-manual/system-requirements.rst +5 -5
index acc97c9d08..8477674b47 100644
@@ -74,12 +74,12 @@ distributions:
       the supported platforms listed below.
 
    -  You may use Windows Subsystem For Linux v2 to set up a build host
-      using Windows 10, but validation is not performed against build
-      hosts using WSLv2.
+      using Windows 10 or 11, or Windows Server 2019 or 2022, but validation
+      is not performed against build hosts using WSL 2.
 
-   -  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.
+      See the
+      :ref:`dev-manual/start:setting up to use windows subsystem for linux (wsl 2)`
+      section in the Yocto Project Development Tasks Manual for more information.
 
    -  If you encounter problems, please go to :yocto_bugs:`Yocto Project
       Bugzilla <>` and submit a bug. We are
Signature · 1 line
2.34.1
Reviewed-by on v1 1/1
#1 lore raw

Hi Michael,

Quoted 27 lines · Michael Opdenacker via lists.yoctoproject.org

From: Michael Opdenacker <[email protected]>

- Use the Wikipedia naming scheme: WSL 2 instead of WSLv2
- Take into account Windows Server 2019 and 2022 which are supported too.
- Improve some explanations

---
  documentation/brief-yoctoprojectqs/index.rst  | 17 ++---
  documentation/dev-manual/start.rst            | 70 +++++++++----------
  documentation/overview-manual/yp-intro.rst    | 17 ++---
  .../ref-manual/system-requirements.rst        | 10 +--
  4 files changed, 50 insertions(+), 64 deletions(-)
documentation/brief-yoctoprojectqs/index.rst +0 -4
index 7ae0ddc349..0dfb4cc7ff 100644
@@ -25,18 +25,11 @@ build a reference embedded OS called Poky.
        in the Yocto Project Development Tasks Manual for more
        information.
 
-   -  You may use Windows Subsystem For Linux v2 to set up a build host
-      using Windows 10.
-
-      .. note::

documentation/brief-yoctoprojectqs/index.rst build a reference embedded OS called Poky. · line 29

Quoted 10 lines
documentation/brief-yoctoprojectqs/index.rst +2 -8
-
-         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.
-
-      See the :ref:`dev-manual/start:setting up to use windows
-      subsystem for linux (wslv2)` section in the Yocto Project Development
-      Tasks Manual for more information.
+   -  You may use version 2 of Windows Subsystem For Linux (WSL 2) to set
+      up a build host using Windows 10 or 11 or Windows Server 2019 or 2022.

Matter of personal taste but I would have written:
Windows 10, Windows 11, Windows Server 2019 or Windows Server 2022

We could probably even say
Windows 10 or later, or Windows Server 2019 or later
since that's currently true and may lower the documentation maintenance burden (provided Microsoft keeps on shipping WSL 2 in later versions, but time will tell :) ).

In any case,

Thanks,
Quentin

#2 lore raw

Hi Quentin,

Quoted 46 lines · Quentin Schulz via lists.yoctoproject.org

Hi Michael,

Quoted 33 lines · Michael Opdenacker via lists.yoctoproject.org

From: Michael Opdenacker <[email protected]>

- Use the Wikipedia naming scheme: WSL 2 instead of WSLv2
- Take into account Windows Server 2019 and 2022 which are supported too.
- Improve some explanations

---
  documentation/brief-yoctoprojectqs/index.rst  | 17 ++--- documentation/dev-manual/start.rst            | 70 +++++++++---------- documentation/overview-manual/yp-intro.rst    | 17 ++--- .../ref-manual/system-requirements.rst        | 10 +--

  4 files changed, 50 insertions(+), 64 deletions(-)
documentation/brief-yoctoprojectqs/index.rst +0 -0
index 7ae0ddc349..0dfb4cc7ff 100644
@@ -25,18 +25,11 @@ build a reference embedded OS called Poky.

        in the Yocto Project Development Tasks Manual for more information.
  -   -  You may use Windows Subsystem For Linux v2 to set up a build host -      using Windows 10.

documentation/brief-yoctoprojectqs/index.rst +0 -9
-
-      .. 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.
-
-      See the :ref:`dev-manual/start:setting up to use windows
-      subsystem for linux (wslv2)` section in the Yocto Project 
Quoted 6 lines

Development
-      Tasks Manual for more information.
+   -  You may use version 2 of Windows Subsystem For Linux (WSL 2) to set
+      up a build host using Windows 10 or 11 or Windows Server 2019 or 2022.

Matter of personal taste but I would have written:
Windows 10, Windows 11, Windows Server 2019 or Windows Server 2022

Quoted 3 lines

We could probably even say
Windows 10 or later, or Windows Server 2019 or later
since that's currently true and may lower the documentation maintenance burden (provided Microsoft keeps on shipping WSL 2 in later versions, but time will tell :) ).

I go for this last one, thanks!
Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com