Skip to content

Commit c81f8e9

Browse files
committed
Merge product/wsl/readme/6.6 into v6.6.36
* commit 'e8bb7797885b28a31b42891d1002ddc17ec926ef': README.md: include building step for modifying configs README.md: Add dwarves to list of build dependencies README.md: Improve the structure of the file README.md: Consolidate WSL specific instructions Update README Update README Add build instructions for WSL2
2 parents cea8057 + e8bb779 commit c81f8e9

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

README-Microsoft.WSL2

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
README.md

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Introduction
2+
3+
The [WSL2-Linux-Kernel][wsl2-kernel] repo contains the kernel source code and
4+
configuration files for the [WSL2][about-wsl2] kernel.
5+
6+
# Reporting Bugs
7+
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.
11+
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].
16+
17+
# Feature Requests
18+
19+
Is there a missing feature that you'd like to see? Please request it on the
20+
[WSL GitHub project][wsl-issue].
21+
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 dwarves libssl-dev libelf-dev`
32+
33+
2. Modify WSL2 kernel configs (optional):
34+
`$ make menuconfig KCONFIG_CONFIG=Microsoft/config-wsl`
35+
36+
Loadable module support is disabled when using a custom built kernel. Set any modules you want to be built-in before building.
37+
38+
3. Build the kernel using the WSL2 kernel configuration:
39+
`$ make KCONFIG_CONFIG=Microsoft/config-wsl`
40+
41+
# Install Instructions
42+
43+
Please see the documentation on the [.wslconfig configuration
44+
file][install-inst] for information on using a custom built kernel.
45+
46+
[wsl2-kernel]: https://github.com/microsoft/WSL2-Linux-Kernel
47+
[about-wsl2]: https://docs.microsoft.com/en-us/windows/wsl/about#what-is-wsl-2
48+
[wsl-issue]: https://github.com/microsoft/WSL/issues/new/choose
49+
[normal-bug]: https://www.kernel.org/doc/html/latest/admin-guide/bug-hunting.html#reporting-the-bug
50+
[security-bug]: https://www.kernel.org/doc/html/latest/admin-guide/security-bugs.html
51+
[submit-patch]: https://www.kernel.org/doc/html/latest/process/submitting-patches.html
52+
[install-inst]: https://docs.microsoft.com/en-us/windows/wsl/wsl-config#configure-global-options-with-wslconfig

0 commit comments

Comments
 (0)