microsoft / microsoft/WSL

Document/stabilise boot.initPath and friends

Open
#10,425 0 comments 0 reactions 1 assignee View on GitHub

@craigloewen-msft is already working on this.

Since Aug 29, 2023.

feature
Dominant language
C++
Stars
33.7k
Forks
1.8k
Avg merge
3d 17h
Merged PRs (30d)
116

Description

**Is your feature request related to a problem? Please describe.**
We currently have to resort to symlinking wrapper scripts into well-known locations to make NixOS run on WSL, because we don't generally install things to "normal" locations. However, there are undocumented wsl.conf options that allow us to directly specify the right paths in the config...

**Describe the solution you'd like**
`boot.initPath`, `boot.initShutdownCommand` and `boot.initWaitCommand` `wsl.conf` settings are stabilized and made part of public API.

**Describe alternatives you've considered**
Continue doing what we're doing, which is tolerable but prone to breaking should WSL ever change how it does things.

**Additional context**
I found the settings by accident while poking the init binary with `strings`. I don't know if they're a recent addition or not.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.