Debugging
Windows
Before building make sure you set environment variable NODE_PTY_DEBUG to 1 to trigger a debug build.
-
Download WinDbg: https://www.microsoft.com/en-us/p/windbg-preview/9pgjgd53tn86?rtc=1&activetab=pivot%3Aoverviewtab
-
Build and run
WinDbgX.exe node .\examples\fork\index.js -
One time setup to set paths:
Open
File > Settings, go toDebugging settingsand set:- Source path to ...\src\win
- Symbol path to ...\build\Debug
-
Break when pty.node is loaded:
-
Go (and break at pty.node):
-
List modules (verify pty.node is loaded):
-
Reload symbols:
-
Examine a function:
You can then open the file by clicking
pty!PtyStartProcessand...\src\win\pty.cclinks. Set a breakpoint by left clicking the gutter. -
Go:
Debugging Winpty
On Windows, you can show the winpty agent console window by adding the environment variable WINPTY_SHOW_CONSOLE=1 to the pty's environment. See https://github.com/rprichard/winpty#debugging-winpty for more information.