dotnet/runtime

CodeGen: Clarify the naming and usage of consumeReg methods

Open

#12,179 opened on Mar 4, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (5,445 forks)batch import
area-CodeGen-coreclrdocumentationhelp wanted

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (Avg merge 12d 11h) (661 merged PRs in 30d)

Description

The naming and usage of the various consumeReg methods is not clearly articulated anywhere. Their usage should probably be documented in codegen.h where they are declared. This came up in the discussion of https://github.com/dotnet/coreclr/pull/22944

category:implementation theme:jit-coding-style skill-level:beginner cost:medium

Contributor guide

Research direction
Examine the consumeReg methods in codegen.h and their usages throughout the JIT codebase, then document the naming convention and usage patterns clearly in codegen.h.
Tech stack
cpp
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75