Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 12, 2025

Fixes #49083

Summary

This PR removes documentation for JIT and GC stress-related environment variables from the user-facing .NET environment variables documentation, as these are internal features used exclusively for dotnet/runtime testing and are not intended for public consumption.

Changes

Removed the entire DOTNET_Jit* and DOTNET_GC* section from docs/core/tools/dotnet-environment-variables.md, including:

  • Environment variables removed from documentation:

    • DOTNET_JitStress
    • DOTNET_JitStressModeNamesOnly
    • DOTNET_GCStress
    • DOTNET_JitNoMemoryBarriers
  • Sections removed:

    • Main section heading and description explaining JIT Stress and GC Hole Stress
    • JIT stress subsection with configuration examples
    • GC Hole stress subsection
    • JIT memory barriers subsection

Rationale

As noted by @jkotas, these environment variables are internal testing features for the dotnet/runtime repository and should only be documented there. Including them in user-facing documentation can cause confusion, as they are not meant to be used by application developers or in production scenarios.

The appropriate documentation for these features should remain in the dotnet/runtime repository for use by runtime developers and testers.

Verification

  • ✅ No other documentation files reference the removed content
  • ✅ No broken links or anchor references
  • ✅ Document structure remains valid with proper section flow
  • ✅ Markdown linting passes
Original prompt

This section details on the original issue you should resolve

<issue_title>DOTNET_Jit* and DOTNET_GC* - improve documentation</issue_title>
<issue_description>### Type of issue

Missing information

Description

The documentation for JIT Stress and GC Hole Stress feels not enough. I still don’t fully understand how those two features work and what exactly I’m looking for in those features to improve code. If possible, I would counsel create a separate link to describe this feature, and so the community could help improving this feature with examples of use cases and how to interpret results.

(Ported from https://devdiv.visualstudio.com/DevDiv/_workitems/edit/2597126.)

Page URL

https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-environment-variables#dotnet_jit-and-dotnet_gc

Content source URL

https://github.com/dotnet/docs/blob/main/docs/core/tools/dotnet-environment-variables.md

Document Version Independent Id

0c8e3542-470a-fa11-0d27-061384c4c3ba

Platform Id

b3c40dba-7bb4-e637-a537-f6ed8757d043

Article author

@meaghanlewis

Metadata

  • ID: c1fab316-eb04-50f5-03c8-bf3004981d3e
  • PlatformId: b3c40dba-7bb4-e637-a537-f6ed8757d043
  • Service: dotnet-fundamentals

Related Issues</issue_description>

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

@jkotas > The documentation for JIT Stress and GC Hole Stress feels not enough

JIT stress and GC stress are internal features for dotnet/runtime testing. They are not meant to be documented for public consumption.</comment_new>
<comment_new>@jkotas
The documentation for these should live in dotnet/runtime repo only. It should be deleted from the user facing docs in this repo.</comment_new>
<comment_new>@jkotas
@copilot Could you please the documentation for JIT and GC stress https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-environment-variables#dotnet_jit-and-dotnet_gc</comment_new>

Fixes #49083


💡 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.


Internal previews

📄 File 🔗 Preview link
docs/core/tools/dotnet-environment-variables.md docs/core/tools/dotnet-environment-variables

Co-authored-by: jkotas <6668460+jkotas@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve documentation for JIT and GC stress features Remove internal JIT and GC stress environment variables from public documentation Oct 12, 2025
Copilot AI requested a review from jkotas October 12, 2025 23:13
Copilot finished work on behalf of jkotas October 12, 2025 23:13
@jkotas jkotas requested a review from gewarren October 12, 2025 23:34
@jkotas jkotas marked this pull request as ready for review October 12, 2025 23:34
@jkotas jkotas requested review from a team and meaghanlewis as code owners October 12, 2025 23:34
Copilot AI review requested due to automatic review settings October 12, 2025 23:34
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

Removes internal JIT and GC stress environment variables from public-facing .NET environment variable documentation to avoid exposing runtime test-only features to end users.

  • Deletes the entire section documenting DOTNET_Jit* and DOTNET_GC* variables.
  • Removes subsections for JIT stress, GC Hole stress, and JIT memory barriers.

@gewarren gewarren merged commit c4f58e5 into main Oct 13, 2025
22 checks passed
@gewarren gewarren deleted the copilot/improve-dotnet-jit-gc-documentation branch October 13, 2025 16:25
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.

DOTNET_Jit* and DOTNET_GC* - improve documentation

3 participants