chipsalliance/chisel

RFC: Deprecate either Decoupled or DecoupledIO?

Offen

#2.463 geöffnet am 28.03.2022

 (12 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Scala (651 Forks)batch import
good first issue

Repository-Metriken

Stars
 (4.658 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 3T 21h) (16 gemergte PRs in 30 T)

Beschreibung

Type of issue: feature request

Impact: API modification

Development Phase: proposal

Other information

If the current behavior is a bug, please provide the steps to reproduce the problem:

What is the current behavior?

User does something like:

val foo: DecoupledIO[Bar] = Decoupled(bar)

There is a mental burden to remember which one is DecoupledIO and which one is Decoupled, for no good reason.

What is the expected behavior?

User would write:

val foo: Decoupled[Bar] = Decoupled(bar)

OR

val foo: DecoupledIO[Bar] = DecoupledIO(bar)

We'd deprecate the other one for a version or so.

Similar for ReadyValids and such, I didn't do a comprehensive survey

Please tell us about your environment:

What is the use case for changing the behavior?

Less mental load for users.

Contributor Guide