MicrosoftDocs / WSL

Source code behind the Windows Subsystem for Linux documentation.
https://docs.microsoft.com/windows/wsl
Other
1.89k stars 556 forks source link

Docs description is not as the same as the setttings in example #1793

Closed counter2015 closed 8 months ago

counter2015 commented 1 year ago

Documentation Issue

doc link: https://learn.microsoft.com/en-us/windows/wsl/wsl-config#example-wslconfig-file

It says

# Turn off default connection to bind WSL 2 localhost to Windows localhost
localhostforwarding=true

# Disables nested virtualization
nestedVirtualization=false

# Turns on output console showing contents of dmesg when opening a WSL 2 distro for debugging
debugConsole=true

It should be Turns on default connection to bind WSL 2 localhost to Windows localhost

Link to documentation page

https://learn.microsoft.com/en-us/windows/wsl/wsl-config#example-wslconfig-file

Suggested Improvements

# Turns on default connection to bind WSL 2 localhost to Windows localhost
localhostforwarding=true

# Disables nested virtualization
nestedVirtualization=false

# Turns on output console showing contents of dmesg when opening a WSL 2 distro for debugging
debugConsole=true
mattwojo commented 8 months ago

Thank you for identifying this issue @counter2015! Fixed in https://github.com/MicrosoftDocs/WSL/pull/1848