Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for WinDbg Preview. #199

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cbiesinger
Copy link
Collaborator

As per https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/loading-debugger-extension-dlls

We could also remove the winext directory suggestion, since this will
work for both "legacy" WinDbg and WinDbg Preview.

docs/README.md Outdated Show resolved Hide resolved
@@ -13,7 +13,9 @@ JsDbg currently supports WinDbg and the Visual Studio debugger on Windows, and G

1. Download the [JsDbg WinDbg extension](https://aka.ms/jsdbg-windbg). (This extension changes infrequently because JsDbg extensions can be updated without updating the WinDbg extension. [Last update: Jan 30th, 2019])

2. Copy jsdbg.dll into the `winext` folder located next your `windbg.exe` installation. Make sure to use the x64 version of the dll for 64-bit WinDbg, and the x86 version for 32-bit WinDbg.
2. Extract the file somewhere and keep track of the directory.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: remove extra space

2. Copy jsdbg.dll into the `winext` folder located next your `windbg.exe` installation. Make sure to use the x64 version of the dll for 64-bit WinDbg, and the x86 version for 32-bit WinDbg.
2. Extract the file somewhere and keep track of the directory.

3. Set the environment variable `_NT_DEBUGGER_EXTENSION_PATH` to the directory containing `jsdbg.dll`. Make sure you use the right version (amd64 vs x86) for the WinDbg version you're using. This will also work with [WinDbg Preview](https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/debugging-using-windbg-preview).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be better to say: "Make sure you use the version (amd64 vs. x86) that corresponds to the WinDbg version that you're using."

2. Copy jsdbg.dll into the `winext` folder located next your `windbg.exe` installation. Make sure to use the x64 version of the dll for 64-bit WinDbg, and the x86 version for 32-bit WinDbg.
2. Extract the file somewhere and keep track of the directory.

3. Set the environment variable `_NT_DEBUGGER_EXTENSION_PATH` to the directory containing `jsdbg.dll`. Make sure you use the right version (amd64 vs x86) for the WinDbg version you're using. This will also work with [WinDbg Preview](https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/debugging-using-windbg-preview).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think we really need the sentence about WinDbg preview? Since these instructions should work for both the Win32 and UWP apps, I don't think we need to say anything specific about either.

contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happened here?

@microsoft-github-updates microsoft-github-updates bot changed the base branch from master to main January 14, 2021 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants