Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jun 6, 2025

The PerfView help documentation contained multiple outdated references to "GC Heap Alloc Stacks" which was renamed to "GC Heap Alloc Ignore Free (Coarse Sampling) Stacks" a long time ago. This caused confusion for users who couldn't find the menu items mentioned in the help.

Changes Made

  • Updated all text references from "GC Heap Alloc Stacks" to "GC Heap Alloc Ignore Free (Coarse Sampling) Stacks" throughout the Users Guide
  • Fixed broken anchor links that pointed to non-existent #GCHeapAlloc section to correctly reference #GCHeapAllocIgnoreFree(CoarseSampling)Stacks
  • Updated the main Memory Group menu description to match the actual menu item name
  • Fixed cross-references in related sections for consistency

Files Changed

  • src/PerfView/SupportFiles/UsersGuide.htm - Updated 11 lines with corrected menu names and fixed links

Verification

  • Confirmed HTML syntax is valid
  • Verified all anchor links now point to existing sections
  • Verified "GC Heap Analyzer" section exists and is correctly documented

This ensures users can successfully navigate the help documentation to find the features they need without encountering broken links or outdated menu names.

Fixes #1788.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…c Stacks'

Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>
Copilot AI changed the title [WIP] Cannot find GC Heap Alloc Stacks on Memory Group menu Fix outdated documentation references to 'GC Heap Alloc Stacks' Jun 6, 2025
Copilot AI requested a review from brianrob June 6, 2025 00:31
you would have to restart the application to collect this information.&nbsp;
</p>
<p>
Once you have the data you can view the data in the &#39;GC Heap Net Mem&#39;, which shows you the call
Copy link
Member

Choose a reason for hiding this comment

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

Let's also update references to "GC Heap Net Mem" to "GC Heap Net Mem (Coarse Sampling)", since this view's name has also changed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated all references to "GC Heap Net Mem" to "GC Heap Net Mem (Coarse Sampling)" throughout the documentation. Changes include the section header and all text/link references. Commit 82437fd.

Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>
@brianrob brianrob marked this pull request as ready for review June 6, 2025 19:12
@brianrob
Copy link
Member

brianrob commented Jun 6, 2025

Copilot Post-Mortem:

  • It was nice that I didn't need to provide additional context for copilot to find users guide, update references to the old name with the new name, and even update links.
  • This makes documentation changes super simple.

Copy link
Member

@mconnew mconnew left a comment

Choose a reason for hiding this comment

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

:shipit:

@brianrob brianrob merged commit 07ac79e into main Jun 6, 2025
5 checks passed
@brianrob brianrob deleted the copilot/fix-1788 branch June 6, 2025 20:40
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.

Cannot find GC Heap Alloc Stacks on Memory Group menu

4 participants