README.md: Improve the structure of the file

Break the file into more sections and make use of more of Markdown's
formatting features for better readability.

Signed-off-by: Tyler Hicks <tyhicks@linux.microsoft.com>
This commit is contained in:
Tyler Hicks 2021-07-23 14:32:12 -05:00
Родитель 9fd8cfd1b8
Коммит 0e280925d1
1 изменённых файлов: 39 добавлений и 18 удалений

Просмотреть файл

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