Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 2, 2025

Summary

Adds Examples sections to dotnet-gcdump collect and dotnet-gcdump report commands, following the established pattern in dotnet-counters.md.

  • dotnet-gcdump collect: 4 examples covering process ID, custom output path, process name with verbose, and custom timeout
  • dotnet-gcdump report: 2 examples covering file-based and process-based report generation

Fixes #20138

Original prompt

This section details on the original issue you should resolve

<issue_title>Add examples to dotnet-gcdump doc</issue_title>
<issue_description>Following the pattern of https://raw.githubusercontent.com/dotnet/docs/master/docs/core/diagnostics/dotnet-counters.md we should have an Examples h3 section following each Options h3 section.

Originally posted by @tdykstra in #19697


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.


Associated WorkItem - 537141</issue_description>

Comments on the Issue (you are @copilot in this section)

@adegeo Thanks :D @gewarren Close/reopen for priority label.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.


Internal previews

📄 File 🔗 Preview link
docs/core/diagnostics/dotnet-gcdump.md docs/core/diagnostics/dotnet-gcdump

Co-authored-by: meaghanlewis <10103121+meaghanlewis@users.noreply.github.com>
Co-authored-by: meaghanlewis <10103121+meaghanlewis@users.noreply.github.com>
Copilot AI changed the title [WIP] Add examples section to dotnet-gcdump documentation Add examples to dotnet-gcdump doc Dec 2, 2025
Copilot finished work on behalf of meaghanlewis December 2, 2025 20:20
Copilot AI requested a review from meaghanlewis December 2, 2025 20:20
@meaghanlewis meaghanlewis marked this pull request as ready for review December 2, 2025 21:24
@meaghanlewis meaghanlewis requested review from a team and tommcdon as code owners December 2, 2025 21:24
Copilot AI review requested due to automatic review settings December 2, 2025 21:24
Copilot finished reviewing on behalf of meaghanlewis December 2, 2025 21:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR successfully adds Examples sections to the dotnet-gcdump documentation, following the established pattern from dotnet-counters.md as requested in issue #20138.

Key changes:

  • Added 4 examples for dotnet-gcdump collect covering common usage scenarios
  • Added 2 examples for dotnet-gcdump report demonstrating both file-based and process-based reporting
  • Included realistic command outputs to help users understand expected results

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add examples to dotnet-gcdump doc

2 participants