rust-lang / rust-lang/rustc-dev-guide

Document more of how to debug HIR

Open
#1,159 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-contributor-onboarding A-HIR E-medium I-terse T-compiler
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

There is the beginnings of a chapter on debugging the HIR, but it is pretty sparse. Is there more or can this be moved somewhere else?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/hir-debugging.md and review the existing chapter to understand what debugging HIR guidance is already present. Identify additional material or a better location for it, then consider the work complete when the HIR debugging documentation is substantially expanded or appropriately relocated.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.