Add documentation for WSL #626

pieandcakes · 2017-04-10T20:57:55Z

@bobbrow @caslan @rajkumar42 @ronglums Please review

WardenGnaw · 2017-04-10T21:26:08Z

Documentation/Debugger/gdb/Windows Subsystem for Linux.md

+* [Visual Studio Code](https://code.visualstudio.com) + Microsoft C/C++ extension for VSCode.
+
+## How-To
+To debug, commands will be routed from Windows through `bash.exe` to setup debugging. Because our extension runs as a 32-bit process, it will need to use the `C:\Windows\SysNative` folder to access the executable that is normally in `C:\Windows\System32`. We will be using the `"pipeTransport"` ability within the extension to do debugging and `"sourceFileMap"` to map the source from the subsystem's paths back to Windows path. 


Which executable?

bash.exe . I'll add that in.

timsneath · 2017-04-10T22:25:30Z

Do we want to include anything about configuration of c_cpp_properties.json so that Linux header files are found instead of Windows ones?

I included the following in mine:

"includePath": [
                "${localappdata}/lxss/rootfs/usr/include",
                "${localappdata}/lxss/rootfs/usr/local/include"            
            ],

@bitcrazed pointed out that this could theoretically be risky. One alternative could be to tell users to copy header files from /usr/include to a location outside of the lxss folder and use that for the includePath, but the problem there is that header updates won't get automatically pulled through. I've stuck with the original solution for now though.

pieandcakes · 2017-04-10T22:28:48Z

@timsneath Thanks for the info. I work on the debugging experience but hopefully @bobbrow @ronglums @sean-mcmanus can chime in. Are there plans for additional instructions/configurations from a Language Server standpoint that you will be providing to help this experience?

timsneath

Few comments enclosed...

timsneath · 2017-04-10T22:30:35Z

Documentation/Debugger/gdb/Windows Subsystem for Linux.md

@@ -0,0 +1,88 @@
+# Windows 10's Windows Subsystem for Linux
+With the release of Windows 10 Creator's Update, you will now be able to use Visual Studio Code and the Microsoft C/C++ extension to debug your `Windows Subsystem for Linux (WSL)` Bash on Ubuntu projects.


I think the official name is "Windows 10 Creators Update" (no apostrophe) - see https://blogs.windows.com/buildingapps/2017/04/05/windows-10-creators-update-creators-update-sdk-released/ for an example.

timsneath · 2017-04-10T22:32:09Z

Documentation/Debugger/gdb/Windows Subsystem for Linux.md

+
+## Prerequisites
+* [Windows 10 Creator's Update with Windows Subsystem for Linux and Bash.](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide)
+* Install g++/gcc and gdb to allow compiling and debugging.


In WSL, right? Not in Windows? Probably want to make that really clear. Perhaps worth calling out sudo apt get build-essential as the right command to get stuff set up, unless you think the audience will already know all this.

Added WSL to the sentence. The command you provided isn't correct but i'll add something in regards to using the package manager to install tools.

timsneath · 2017-04-10T22:34:48Z

Documentation/Debugger/gdb/Windows Subsystem for Linux.md

+To debug, commands will be routed from Windows through `bash.exe` to setup debugging. Because our extension runs as a 32-bit process, it will need to use the `C:\Windows\SysNative` folder to access the `bash.exe` executable that is normally in `C:\Windows\System32`. We will be using the `"pipeTransport"` ability within the extension to do debugging and `"sourceFileMap"` to map the source from the subsystem's paths back to Windows path. 
+
+**NOTE: Applications will need to be compiled in the `Windows Subsystem for Linux (WSL)` prior to debugging.**
+


Probably worth a link back to https://code.visualstudio.com/Docs/editor/debugging so users who aren't familiar with launch.json and debugging in Visual Studio Code in general have a point of reference...? This page also explains how to create a launch.json and the various elements contained within it.

@timsneath This isn't a tutorial but an addition of documentation within our repo for debugging. As such, I'm assuming that the user knows launch.json

timsneath · 2017-04-10T22:39:54Z

Documentation/Debugger/gdb/Windows Subsystem for Linux.md

+        }
+```
+
+### Example `launch.json` for Attaching to an Existing Process


Maybe I'm dumb, but I don't understand when I'd use the latter? This is like Debug / Attach to Process in 'full' VS, right?

If you have a process already running in Bash on Windows and want to debug it, this is how you do it.

bobbrow · 2017-04-11T00:04:47Z

Documentation/Debugger/gdb/Windows Subsystem for Linux.md

+* [Visual Studio Code](https://code.visualstudio.com) + Microsoft C/C++ extension for VSCode.
+
+## How-To
+To debug, commands will be routed from Windows through `bash.exe` to setup debugging. Because our extension runs as a 32-bit process, it will need to use the `C:\Windows\SysNative` folder to access the `bash.exe` executable that is normally in `C:\Windows\System32`. We will be using the `"pipeTransport"` ability within the extension to do debugging and `"sourceFileMap"` to map the source from the subsystem's paths back to Windows path. 


setup is used as a verb a few times in this document, but when spelled as one word it is a noun. Replace with set up (two words)

bitcrazed · 2017-04-11T00:20:10Z

@robotdad Are you able to shed some light on how VC++ for Linux handles headers & Intellisense?

robotdad · 2017-04-11T00:37:19Z

For VC Linux support we carry basic IntelliSense for libstdc++, it isn't tailored for any specific Linux system. To get IntelliSense specific to your Linux system you need to copy your include files (or map them to a Windows drive etc.) and give that local path to VS to parse them. That's described here

bitcrazed · 2017-04-11T00:58:46Z

🍺 to Marc for NOT instructing users to copy files from %localappdata%\lxss

Using [p]scp to copy files from Linux is a MUCH better bet.

Add documentation for WSL

544b860

pieandcakes mentioned this pull request Apr 10, 2017

Can Bash on Ubuntu For Windows be used with the VSCode extension? #85

Closed

rajkumar42 approved these changes Apr 10, 2017

View reviewed changes

WardenGnaw reviewed Apr 10, 2017

View reviewed changes

PR comments

74ed228

WardenGnaw approved these changes Apr 10, 2017

View reviewed changes

timsneath reviewed Apr 10, 2017

View reviewed changes

bobbrow reviewed Apr 11, 2017

View reviewed changes

Comment updates

2498dbf

pieandcakes merged commit f974963 into master Apr 11, 2017

pieandcakes deleted the users/piel/WSL branch December 28, 2017 22:57

github-actions bot locked and limited conversation to collaborators Oct 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for WSL #626

Add documentation for WSL #626

pieandcakes commented Apr 10, 2017 •

edited

Loading

WardenGnaw Apr 10, 2017

pieandcakes Apr 10, 2017

timsneath commented Apr 10, 2017

pieandcakes commented Apr 10, 2017

timsneath left a comment

timsneath Apr 10, 2017

pieandcakes Apr 11, 2017

timsneath Apr 10, 2017

pieandcakes Apr 11, 2017

timsneath Apr 10, 2017

pieandcakes Apr 11, 2017

timsneath Apr 10, 2017

pieandcakes Apr 11, 2017 •

edited

Loading

bobbrow Apr 11, 2017

pieandcakes Apr 11, 2017

bitcrazed commented Apr 11, 2017

robotdad commented Apr 11, 2017

bitcrazed commented Apr 11, 2017

		@@ -0,0 +1,88 @@
		# Windows 10's Windows Subsystem for Linux
		With the release of Windows 10 Creator's Update, you will now be able to use Visual Studio Code and the Microsoft C/C++ extension to debug your `Windows Subsystem for Linux (WSL)` Bash on Ubuntu projects.

		To debug, commands will be routed from Windows through `bash.exe` to setup debugging. Because our extension runs as a 32-bit process, it will need to use the `C:\Windows\SysNative` folder to access the `bash.exe` executable that is normally in `C:\Windows\System32`. We will be using the `"pipeTransport"` ability within the extension to do debugging and `"sourceFileMap"` to map the source from the subsystem's paths back to Windows path.

		NOTE: Applications will need to be compiled in the `Windows Subsystem for Linux (WSL)` prior to debugging.

Add documentation for WSL #626

Add documentation for WSL #626

Conversation

pieandcakes commented Apr 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timsneath commented Apr 10, 2017

pieandcakes commented Apr 10, 2017

timsneath left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pieandcakes Apr 11, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bitcrazed commented Apr 11, 2017

robotdad commented Apr 11, 2017

bitcrazed commented Apr 11, 2017

pieandcakes commented Apr 10, 2017 •

edited

Loading

pieandcakes Apr 11, 2017 •

edited

Loading