-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Add dotnet-debug base docs #51570
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
base: main
Are you sure you want to change the base?
Add dotnet-debug base docs #51570
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds initial documentation and navigation entry for the new dotnet-debug diagnostics tool, so it appears alongside other .NET CLI global tools and has a dedicated reference page.
Changes:
- Adds
dotnet-debugto the diagnostics tools TOC. - Introduces a new reference article covering install, commands (
attach,open-dump), and a list of SOS commands.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| docs/navigate/tools-diagnostics/toc.yml | Adds dotnet-debug to the “.NET CLI global tools” navigation list. |
| docs/core/diagnostics/dotnet-debug.md | New documentation page for dotnet-debug installation, usage, and command reference. |
| | Command | Function | | ||
| |-----------------------------------------------------|----------| | ||
| | `analyzeoom` | Displays the info of the last OOM that occurred on an allocation request to the GC heap. | | ||
| | `clrmodules` | Lists the managed modules in the process. | |
Copilot
AI
Feb 10, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This SOS commands table uses || at the start of each row, which will break Markdown table rendering. Switch to standard table syntax (single leading |) like other docs in this repo.
| | Feature | `dotnet-debug` | `dotnet-dump` | | ||
| | ------- | -------------- | ------------- | | ||
| | Attach to a live process | ✔️ | ❌ | | ||
| | Collect dumps | ❌ | ✔️ | |
Copilot
AI
Feb 10, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feature comparison table uses || at the start of each row, which won’t render correctly as a Markdown table. Use standard | table formatting.
01f7746 to
07808a2
Compare
07808a2 to
b9e1d5a
Compare
Summary
Adds basic documentation for new tool dotnet-debug
Internal previews