Skip to content

Commit 502cd38

Browse files
committed
Note the pre-release VS Code requirements
1 parent 77ffc71 commit 502cd38

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

docs/debugging/README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Debugging
22
=========
33

44
VS Code
5-
-------
5+
=======
66

77
[Experimental .NET Core Debugging in VS Code][core-debug] enables
88
cross-platform debugging with the [Visual Studio Code][vscode] editor.
@@ -38,19 +38,32 @@ process named `powershell`, and will attach to it. If you need more
3838
fine grained control, replace `processName` with `processId` and
3939
provide a PID. (Please be careful not to commit such a change).
4040

41+
Important Note
42+
--------------
43+
44+
Debugging is very sensitive to the versions of our .NET Core packages, VS Code,
45+
and the C# extension.
46+
47+
- Use the VS Code [Insiders][] build
48+
- Use the latest pre-release of the [C# extension][]
49+
- Refer to the pre-release [documentation][]
50+
4151
[core-debug]: https://blogs.msdn.microsoft.com/visualstudioalm/2016/03/10/experimental-net-core-debugging-in-vs-code/
4252
[vscode]: https://code.visualstudio.com/
4353
[OmniSharp]: https://github.com/OmniSharp/omnisharp-vscode
4454
[vscclrdebugger]: http://aka.ms/vscclrdebugger
55+
[insiders]: https://code.visualstudio.com/insiders
56+
[C# extension]: https://github.com/OmniSharp/omnisharp-vscode/releases
57+
[documentation]: https://github.com/OmniSharp/omnisharp-vscode/pull/157
4558

4659
corehost
47-
--------
60+
========
4861

4962
The native executable prouduced by .NET CLI will produce trace output
5063
if launched with `COREHOST_TRACE=1 ./powershell`.
5164

5265
CoreCLR PAL
53-
-----------
66+
===========
5467

5568
The native code in the CLR has debug channels to selectively output
5669
information to the console. These are controlled by the

0 commit comments

Comments
 (0)