|
1 | | -= Introduction = |
| 1 | +# Introduction |
2 | 2 |
|
3 | | -The WSL 2 Linux kernel repo provides the additional infrastructure necessary |
4 | | -to build and release the kernel component of WSL 2. It was never designed to |
5 | | -replace the current existing community and feedback channels for WSL, |
6 | | -especially through: https://github.com/microsoft/WSL. This is why we are not |
7 | | -accepting issues or pull requests through this repository. |
| 3 | +The [WSL2-Linux-Kernel][wsl2-kernel] repo contains the kernel source code and |
| 4 | +configuration files for the [WSL2][about-wsl2] kernel. |
8 | 5 |
|
9 | | -If you have an issue relating to WSL, or the WSL 2 Linux kernel configuration, |
10 | | -please report it at the WSL GitHub: would like contribute to or report an issue |
11 | | -on the WSL2 kernel, please do so at the WSL GitHub: |
| 6 | +# Reporting Bugs |
12 | 7 |
|
13 | | -https://github.com/microsoft/WSL/issues/new/choose |
| 8 | +If you discover an issue relating to WSL or the WSL2 kernel, please report it on |
| 9 | +the [WSL GitHub project][wsl-issue]. It is not possible to report issues on the |
| 10 | +[WSL2-Linux-Kernel][wsl2-kernel] project. |
14 | 11 |
|
15 | | -The WSL 2 Linux kernel is based on the Linux version from |
16 | | -https://www.kernel.org/. If you would like to contribute to or report an issue |
17 | | -on the Linux kernel in general, please do so on the upstream Linux GitHub: |
| 12 | +If you're able to determine that the bug is present in the upstream Linux |
| 13 | +kernel, you may want to work directly with the upstream developers. Please note |
| 14 | +that there are separate processes for reporting a [normal bug][normal-bug] and |
| 15 | +a [security bug][security-bug]. |
18 | 16 |
|
19 | | -https://www.kernel.org/doc/html/latest/process/submitting-patches.html |
| 17 | +# Feature Requests |
20 | 18 |
|
21 | | -= Build Instructions = |
| 19 | +Is there a missing feature that you'd like to see? Please request it on the |
| 20 | +[WSL GitHub project][wsl-issue]. |
22 | 21 |
|
23 | | -1. Install a recent Ubuntu distribution |
24 | | -2. sudo apt install build-essential flex bison libssl-dev libelf-dev |
25 | | -3. make KCONFIG_CONFIG=Microsoft/config-wsl |
| 22 | +If you're able and interested in contributing kernel code for your feature |
| 23 | +request, we encourage you to [submit the change upstream][submit-patch]. |
| 24 | + |
| 25 | +# Build Instructions |
| 26 | + |
| 27 | +Instructions for building an x86_64 WSL2 kernel with an Ubuntu distribution are |
| 28 | +as follows: |
| 29 | + |
| 30 | +1. Install the build dependencies: |
| 31 | + `$ sudo apt install build-essential flex bison libssl-dev libelf-dev` |
| 32 | +2. Build the kernel using the WSL2 kernel configuration: |
| 33 | + `$ make KCONFIG_CONFIG=Microsoft/config-wsl` |
| 34 | + |
| 35 | +# Install Instructions |
| 36 | + |
| 37 | +Please see the documentation on the [.wslconfig configuration |
| 38 | +file][install-inst] for information on using a custom built kernel. |
| 39 | + |
| 40 | +[wsl2-kernel]: https://github.com/microsoft/WSL2-Linux-Kernel |
| 41 | +[about-wsl2]: https://docs.microsoft.com/en-us/windows/wsl/about#what-is-wsl-2 |
| 42 | +[wsl-issue]: https://github.com/microsoft/WSL/issues/new/choose |
| 43 | +[normal-bug]: https://www.kernel.org/doc/html/latest/admin-guide/bug-hunting.html#reporting-the-bug |
| 44 | +[security-bug]: https://www.kernel.org/doc/html/latest/admin-guide/security-bugs.html |
| 45 | +[submit-patch]: https://www.kernel.org/doc/html/latest/process/submitting-patches.html |
| 46 | +[install-inst]: https://docs.microsoft.com/en-us/windows/wsl/wsl-config#configure-global-options-with-wslconfig |
0 commit comments