Updated docs for usbipd-win updates #1870
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Learn Build status updates of commit 5c7166d: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
dorssel
suggested changes
Dec 8, 2023
There was a problem hiding this comment.
Overall, the changes are correct, but more changes are required. See https://github.com/dorssel/usbipd-win/wiki/WSL-support (first part, up to udev) for additional details.
Co-authored-by: Frans van Dorsselaer <[email protected]>
|
Learn Build status updates of commit 2cac1fd: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Thank you @dorssel !
|
Learn Build status updates of commit 7cc38ef: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
mattwojo
approved these changes
Jan 5, 2024
|
@craigloewen-msft Looks good to me. Please have a look and merge if it seems ready. |
This was referenced Jan 5, 2024
Closed
dorssel
suggested changes
Jan 5, 2024
There was a problem hiding this comment.
It is not possible to add suggestions for collapsed (non-changed) lines, but line 37 should become:
> Alternatively, you can also install the usbipd-win project using [Windows Package Manager](/windows/package-manager/winget/) (winget). If you have already installed winget, just use the command: `winget install --exact dorssel.usbipd-win` to install usbipd-win.
(the part about automatic reboots is obsolete).
Co-authored-by: Frans van Dorsselaer <[email protected]>
Co-authored-by: Frans van Dorsselaer <[email protected]>
|
Learn Build status updates of commit 03c040c: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit e49d82f: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
mattwojo
added a commit
that referenced
this pull request
Feb 2, 2024
* Fixing small formatting and writing errors. (#1863) * Fix broken code block and bookmark link (#1866) * Fix broken code block * Update broken wslconfig bookmark * Update install-on-server.md (#1871) Fix indent and numbering for better readability. * Fix punctuation errors (#1876) * small improvements in troubleshooting.md (#1877) Some small formatting improvements. Also added the command to restart the hns service. * Fix a few typos (#1879) Co-authored-by: Matt Wojciakowski <[email protected]> * Updated guide to fix an issue because of a wrong command (#1884) * Update wsl-containers.md Running Dev Containers: **Open Folder in Container...** when using this guide is not / no longer correct, as most readers will already have opened the folder while connected to WSL based on the steps provided above. We need to use **Dev Containers: Reopen in Container** or it will fail to create the .devcontainer folder and devcontainer.json and give a (unfortunately not very clear) error message. See also: https://code.visualstudio.com/docs/devcontainers/containers#_open-a-wsl-2-folder-in-a-container-on-windows - Use the Dev Containers: Reopen in Container command from a folder already opened using the WSL extension. - Select Dev Containers: Open Folder in Container... from the Command Palette (F1) and choose a WSL folder using the local \\wsl$ share (from the Windows side). * Update wsl-containers.md --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Update faq.yml -- tiny grammar change (#1885) * Update faq.yml -- tiny grammar change 'changes to locale to' -> 'changes the locale to' * Update basic-commands.md 'If you running WSL' -> 'If you run WSL' * Update basic-commands.md * rephrase a long sentence * swap order of two sentences to make example of command closer to the description of the command example of command: `wsl --set-default-version 2` * Update basic-commands.md Replace wsl -u <Username>`, `wsl --user <Username> with wsl --user <Username> `wsl -u <Username>` and `wsl --user <Username>` are equivalent. Both commands are correct for the section of the documentation, but the display of the commands in the documentation was incorrect due to the stray ticks and comma. * Update gui-apps.md to simplify commits. (#1880) * Update gui-apps.md If we are already referencing apt, why not just use apt to install google chrome? * Update gui-apps.md forgot --fix-missing * Add a note to explain the command flags and path --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Fix anchor warning * Updated docs for usbipd-win updates (#1870) * Updated docs for usbipd-win updates * Update url to latest Co-authored-by: Frans van Dorsselaer <[email protected]> * Fixes based on feedback Thank you @dorssel ! * Remove admin requirement Co-authored-by: Frans van Dorsselaer <[email protected]> * Remove x86 support Co-authored-by: Frans van Dorsselaer <[email protected]> --------- Co-authored-by: Matt Wojciakowski <[email protected]> Co-authored-by: Frans van Dorsselaer <[email protected]> * Moving experimental settings to the experimental section (#1901) * Moving experimental settings to the experimental section Some networking config settings are still experimental. Moving those to the experimental section of the document so customers know how to use these settings. * Added code ticks to new setting entries * Update wsl-config.md fixing settings which are no longer experimental, but the text still referred to them as experimental * Update wsl-config.md fixed the string referring to autoProxy. it's no longer experimental. --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Moving ms.prod and ms.technology to ms.service and ms.subservice * Update to new feedback mechanism (#1917) * Update to new feedback mechanism * fix desc syntax * Fix template link * add svg support --------- Co-authored-by: Stefan Nikolaj <[email protected]> Co-authored-by: Anton Kesy <[email protected]> Co-authored-by: Ishan Jain <[email protected]> Co-authored-by: Krishna Vivek Vitta <[email protected]> Co-authored-by: icyerasor <[email protected]> Co-authored-by: Blake-Madden <[email protected]> Co-authored-by: vmsteiner <[email protected]> Co-authored-by: Andrew Zipperer <[email protected]> Co-authored-by: Wes Bryie <[email protected]> Co-authored-by: Craig Loewen <[email protected]> Co-authored-by: Frans van Dorsselaer <[email protected]> Co-authored-by: Keith Horton <[email protected]> Co-authored-by: Drew Batchelor (he/him) <[email protected]>
mattwojo
added a commit
that referenced
this pull request
Feb 22, 2024
* Fixing small formatting and writing errors. (#1863) * Fix broken code block and bookmark link (#1866) * Fix broken code block * Update broken wslconfig bookmark * Update install-on-server.md (#1871) Fix indent and numbering for better readability. * Fix punctuation errors (#1876) * small improvements in troubleshooting.md (#1877) Some small formatting improvements. Also added the command to restart the hns service. * Fix a few typos (#1879) Co-authored-by: Matt Wojciakowski <[email protected]> * Updated guide to fix an issue because of a wrong command (#1884) * Update wsl-containers.md Running Dev Containers: **Open Folder in Container...** when using this guide is not / no longer correct, as most readers will already have opened the folder while connected to WSL based on the steps provided above. We need to use **Dev Containers: Reopen in Container** or it will fail to create the .devcontainer folder and devcontainer.json and give a (unfortunately not very clear) error message. See also: https://code.visualstudio.com/docs/devcontainers/containers#_open-a-wsl-2-folder-in-a-container-on-windows - Use the Dev Containers: Reopen in Container command from a folder already opened using the WSL extension. - Select Dev Containers: Open Folder in Container... from the Command Palette (F1) and choose a WSL folder using the local \\wsl$ share (from the Windows side). * Update wsl-containers.md --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Update faq.yml -- tiny grammar change (#1885) * Update faq.yml -- tiny grammar change 'changes to locale to' -> 'changes the locale to' * Update basic-commands.md 'If you running WSL' -> 'If you run WSL' * Update basic-commands.md * rephrase a long sentence * swap order of two sentences to make example of command closer to the description of the command example of command: `wsl --set-default-version 2` * Update basic-commands.md Replace wsl -u <Username>`, `wsl --user <Username> with wsl --user <Username> `wsl -u <Username>` and `wsl --user <Username>` are equivalent. Both commands are correct for the section of the documentation, but the display of the commands in the documentation was incorrect due to the stray ticks and comma. * Update gui-apps.md to simplify commits. (#1880) * Update gui-apps.md If we are already referencing apt, why not just use apt to install google chrome? * Update gui-apps.md forgot --fix-missing * Add a note to explain the command flags and path --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Fix anchor warning * Updated docs for usbipd-win updates (#1870) * Updated docs for usbipd-win updates * Update url to latest Co-authored-by: Frans van Dorsselaer <[email protected]> * Fixes based on feedback Thank you @dorssel ! * Remove admin requirement Co-authored-by: Frans van Dorsselaer <[email protected]> * Remove x86 support Co-authored-by: Frans van Dorsselaer <[email protected]> --------- Co-authored-by: Matt Wojciakowski <[email protected]> Co-authored-by: Frans van Dorsselaer <[email protected]> * Moving experimental settings to the experimental section (#1901) * Moving experimental settings to the experimental section Some networking config settings are still experimental. Moving those to the experimental section of the document so customers know how to use these settings. * Added code ticks to new setting entries * Update wsl-config.md fixing settings which are no longer experimental, but the text still referred to them as experimental * Update wsl-config.md fixed the string referring to autoProxy. it's no longer experimental. --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Moving ms.prod and ms.technology to ms.service and ms.subservice * Update to new feedback mechanism (#1917) * Update to new feedback mechanism * fix desc syntax * Fix template link * add svg support * Update wsl-config.md to document the dnsProxy option (#1920) dnsProxy is a wls2 configuration option which we need to document for customers that need to turn off the NAT DNS proxy. * User/chdhan/networking doc update 2/21/24 (#1928) * Signed-off-by: Chanpreet Dhanjal <[email protected]> * updating troubleshooting page. * Updating troubleshooting guide * updating troubleshooting guide * Editorial update, added explainer * Update image alt text for accessibility --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Fix typo (#1924) Github -> GitHub * Fix typo (#1923) Github -> GitHub * Removed mention of deprecated content (#1915) * FAQ: Split Hyper-V and Windows Home questions into two (#1914) * FAQ: Split Hyper-V and Windows Home questions into two Fixes #899 * FAQ: clarify WSL features need to be enabled * Update wsl-plugins.md (#1913) * Import export command clarification (#1910) * Split the import and export commands into separate sections - My original intent was to clarify that the export command exports a **snapshot** of the specified distribution. The way it is currently written doesn't say otherwise, but it could be interpreted to mean it exports a clean install without the user's modifications. - In other words, it could be saying `wsl --export Ubuntu ubuntu.tar` is equivalent to downloading the official "ubuntu.tar" from the internet. - Splitting these two was not part of my original goal, merely a step along the way to achieve it. - I decided to make this its own commit so that it can be `cherry-pick`ed if it provides value on its own but the upcoming commits do not. * Specify that the export command exports a snapshot * Fix orphan links to import/export command sections * fix ambiguous wording for required win version (#1895) Previously the docs stated that Windows version 22H2 was required, but that is wrong: microsoft/WSL#10853 it is specifically Windows *11* version 22H2 that is required. --------- Co-authored-by: Stefan Nikolaj <[email protected]> Co-authored-by: Anton Kesy <[email protected]> Co-authored-by: Ishan Jain <[email protected]> Co-authored-by: Krishna Vivek Vitta <[email protected]> Co-authored-by: icyerasor <[email protected]> Co-authored-by: Blake-Madden <[email protected]> Co-authored-by: vmsteiner <[email protected]> Co-authored-by: Andrew Zipperer <[email protected]> Co-authored-by: Wes Bryie <[email protected]> Co-authored-by: Craig Loewen <[email protected]> Co-authored-by: Frans van Dorsselaer <[email protected]> Co-authored-by: Keith Horton <[email protected]> Co-authored-by: Drew Batchelor (he/him) <[email protected]> Co-authored-by: chanpreetdhanjal <[email protected]> Co-authored-by: Takashi Takebayashi <[email protected]> Co-authored-by: Patrick Brosset <[email protected]> Co-authored-by: Daniel Kaplan <[email protected]> Co-authored-by: Saisang Cai <[email protected]> Co-authored-by: jantari <[email protected]>
mattwojo
added a commit
that referenced
this pull request
Mar 20, 2024
* Fixing small formatting and writing errors. (#1863) * Fix broken code block and bookmark link (#1866) * Fix broken code block * Update broken wslconfig bookmark * Update install-on-server.md (#1871) Fix indent and numbering for better readability. * Fix punctuation errors (#1876) * small improvements in troubleshooting.md (#1877) Some small formatting improvements. Also added the command to restart the hns service. * Fix a few typos (#1879) Co-authored-by: Matt Wojciakowski <[email protected]> * Updated guide to fix an issue because of a wrong command (#1884) * Update wsl-containers.md Running Dev Containers: **Open Folder in Container...** when using this guide is not / no longer correct, as most readers will already have opened the folder while connected to WSL based on the steps provided above. We need to use **Dev Containers: Reopen in Container** or it will fail to create the .devcontainer folder and devcontainer.json and give a (unfortunately not very clear) error message. See also: https://code.visualstudio.com/docs/devcontainers/containers#_open-a-wsl-2-folder-in-a-container-on-windows - Use the Dev Containers: Reopen in Container command from a folder already opened using the WSL extension. - Select Dev Containers: Open Folder in Container... from the Command Palette (F1) and choose a WSL folder using the local \\wsl$ share (from the Windows side). * Update wsl-containers.md --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Update faq.yml -- tiny grammar change (#1885) * Update faq.yml -- tiny grammar change 'changes to locale to' -> 'changes the locale to' * Update basic-commands.md 'If you running WSL' -> 'If you run WSL' * Update basic-commands.md * rephrase a long sentence * swap order of two sentences to make example of command closer to the description of the command example of command: `wsl --set-default-version 2` * Update basic-commands.md Replace wsl -u <Username>`, `wsl --user <Username> with wsl --user <Username> `wsl -u <Username>` and `wsl --user <Username>` are equivalent. Both commands are correct for the section of the documentation, but the display of the commands in the documentation was incorrect due to the stray ticks and comma. * Update gui-apps.md to simplify commits. (#1880) * Update gui-apps.md If we are already referencing apt, why not just use apt to install google chrome? * Update gui-apps.md forgot --fix-missing * Add a note to explain the command flags and path --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Fix anchor warning * Updated docs for usbipd-win updates (#1870) * Updated docs for usbipd-win updates * Update url to latest Co-authored-by: Frans van Dorsselaer <[email protected]> * Fixes based on feedback Thank you @dorssel ! * Remove admin requirement Co-authored-by: Frans van Dorsselaer <[email protected]> * Remove x86 support Co-authored-by: Frans van Dorsselaer <[email protected]> --------- Co-authored-by: Matt Wojciakowski <[email protected]> Co-authored-by: Frans van Dorsselaer <[email protected]> * Moving experimental settings to the experimental section (#1901) * Moving experimental settings to the experimental section Some networking config settings are still experimental. Moving those to the experimental section of the document so customers know how to use these settings. * Added code ticks to new setting entries * Update wsl-config.md fixing settings which are no longer experimental, but the text still referred to them as experimental * Update wsl-config.md fixed the string referring to autoProxy. it's no longer experimental. --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Moving ms.prod and ms.technology to ms.service and ms.subservice * Update to new feedback mechanism (#1917) * Update to new feedback mechanism * fix desc syntax * Fix template link * add svg support * Update wsl-config.md to document the dnsProxy option (#1920) dnsProxy is a wls2 configuration option which we need to document for customers that need to turn off the NAT DNS proxy. * User/chdhan/networking doc update 2/21/24 (#1928) * Signed-off-by: Chanpreet Dhanjal <[email protected]> * updating troubleshooting page. * Updating troubleshooting guide * updating troubleshooting guide * Editorial update, added explainer * Update image alt text for accessibility --------- Co-authored-by: Matt Wojciakowski <[email protected]> * Fix typo (#1924) Github -> GitHub * Fix typo (#1923) Github -> GitHub * Removed mention of deprecated content (#1915) * FAQ: Split Hyper-V and Windows Home questions into two (#1914) * FAQ: Split Hyper-V and Windows Home questions into two Fixes #899 * FAQ: clarify WSL features need to be enabled * Update wsl-plugins.md (#1913) * Import export command clarification (#1910) * Split the import and export commands into separate sections - My original intent was to clarify that the export command exports a **snapshot** of the specified distribution. The way it is currently written doesn't say otherwise, but it could be interpreted to mean it exports a clean install without the user's modifications. - In other words, it could be saying `wsl --export Ubuntu ubuntu.tar` is equivalent to downloading the official "ubuntu.tar" from the internet. - Splitting these two was not part of my original goal, merely a step along the way to achieve it. - I decided to make this its own commit so that it can be `cherry-pick`ed if it provides value on its own but the upcoming commits do not. * Specify that the export command exports a snapshot * Fix orphan links to import/export command sections * fix ambiguous wording for required win version (#1895) Previously the docs stated that Windows version 22H2 was required, but that is wrong: microsoft/WSL#10853 it is specifically Windows *11* version 22H2 that is required. * Updating troubleshooting page * User/chdhan/wsl troubleshooting doc update 3 18 23 (#1936) * Signed-off-by: Chanpreet Dhanjal <[email protected]> Upating pages to reflect support for IPV4 and IPV6 * Updated text * Minor editorial update We try to only use "note:" to indicate actual formatted notes. * Minor editorial updates --------- Co-authored-by: Matt Wojciakowski <[email protected]> --------- Co-authored-by: Stefan Nikolaj <[email protected]> Co-authored-by: Anton Kesy <[email protected]> Co-authored-by: Ishan Jain <[email protected]> Co-authored-by: Krishna Vivek Vitta <[email protected]> Co-authored-by: icyerasor <[email protected]> Co-authored-by: Blake-Madden <[email protected]> Co-authored-by: vmsteiner <[email protected]> Co-authored-by: Andrew Zipperer <[email protected]> Co-authored-by: Wes Bryie <[email protected]> Co-authored-by: Craig Loewen <[email protected]> Co-authored-by: Frans van Dorsselaer <[email protected]> Co-authored-by: Keith Horton <[email protected]> Co-authored-by: Drew Batchelor (he/him) <[email protected]> Co-authored-by: chanpreetdhanjal <[email protected]> Co-authored-by: Takashi Takebayashi <[email protected]> Co-authored-by: Patrick Brosset <[email protected]> Co-authored-by: Daniel Kaplan <[email protected]> Co-authored-by: Saisang Cai <[email protected]> Co-authored-by: jantari <[email protected]> Co-authored-by: Chanpreet Dhanjal <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the docs to reflect the changes in usbipd-win 4.0.0
See the full changes list and discussion here.