Skip to content

JIT: Update overview document and rename a few methods#119762

Merged
jakobbotsch merged 2 commits intodotnet:mainfrom
jakobbotsch:update-jit-doc
Sep 30, 2025
Merged

JIT: Update overview document and rename a few methods#119762
jakobbotsch merged 2 commits intodotnet:mainfrom
jakobbotsch:update-jit-doc

Conversation

@jakobbotsch
Copy link
Member

  • Update list of phases in the overview to include some more phases
  • Rename one of the compCompile overloads to compCompileAfterInit. Keep compCompile as the method that runs the phases.
  • Rename local morph to actually be called local morph
  • Leave a note in the ryujit tutorial that the phase information and details are out of date, and point into the overview instead

- Update list of phases in the overview to include some more phases
- Rename one of the `compCompile` overloads to `compCompileAfterInit`.
  Keep `compCompile` as the method that runs the phases.
- Rename local morph to actually be called local morph
- Leave a note in the ryujit tutorial that the phase information and
  details are out of date, and point into the overview instead
Copilot AI review requested due to automatic review settings September 16, 2025 13:52
@github-actions github-actions bot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Sep 16, 2025
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 updates documentation and renames methods to improve clarity and consistency in the JIT codebase. The primary focus is on better documenting JIT phases and making method names more descriptive.

Key changes:

  • Updates the RyuJIT overview document with more comprehensive phase information and corrected details
  • Renames fgMarkAddressExposedLocals to fgLocalMorph to better reflect its broader functionality
  • Renames one compCompile overload to compCompileAfterInit to distinguish initialization from phase execution

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/coreclr/jit/lclmorph.cpp Renames function and updates comment to reflect broader local morphing functionality
src/coreclr/jit/ee_il_dll.cpp Updates comment reference and simplifies memcpy operation
src/coreclr/jit/compphases.h Renames phase constant to match the new function name
src/coreclr/jit/compiler.h Updates function declaration and fixes typo in comment
src/coreclr/jit/compiler.cpp Updates function calls and renames method implementation
docs/design/coreclr/jit/ryujit-tutorial.md Adds deprecation notice and reference to updated overview
docs/design/coreclr/jit/ryujit-overview.md Comprehensive updates to phase descriptions, IR details, and technical accuracy

@dotnet-policy-service
Copy link
Contributor

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

@jakobbotsch
Copy link
Member Author

PTAL @dotnet/jit-contrib

@jakobbotsch jakobbotsch requested a review from a team September 16, 2025 18:05
Copy link
Member

@AndyAyersMS AndyAyersMS left a comment

Choose a reason for hiding this comment

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

Left a comment for one bit I found confusing.

@jakobbotsch
Copy link
Member Author

/ba-g Deadletter on trivial change

@jakobbotsch jakobbotsch merged commit 8dda9b5 into dotnet:main Sep 30, 2025
111 of 113 checks passed
@jakobbotsch jakobbotsch deleted the update-jit-doc branch September 30, 2025 17:27
@JulieLeeMSFT
Copy link
Member

Thanks for updating the overview doc.

@github-actions github-actions bot locked and limited conversation to collaborators Oct 31, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants