Tracking issue for RFC 36: Async testbench functions

amaranth-lang / amaranth

A modern hardware definition language and toolchain based on Python

https://amaranth-lang.org/docs/amaranth/

BSD 2-Clause "Simplified" License

1.51k stars 168 forks source link

Tracking issue for RFC 36: Async testbench functions #1213

Open zyp opened 4 months ago

zyp commented 4 months ago

RFC PR: https://github.com/amaranth-lang/rfcs/pull/36
Implementation PR: https://github.com/amaranth-lang/amaranth/pull/1344
Documentation PR: https://github.com/amaranth-lang/amaranth/pull/1374
Removal of deprecation PR: N/A

whitequark commented 2 months ago

This still needs to be documented, so I'll keep it open for now.

cr1901 commented 1 month ago

This still needs to be documented, so I'll keep it open for now.

Will generator functions be deprecated in 0.6 instead of 0.5? async testbenches made the 0.5 cutoff, and the RFC mentions deprecation of generator functions at the very end. But I don't see anything about deprecation in the CHANGELOG/porting guide from 0.4 to 0.5.

(Basically, "I'd like to quickly migrate to 0.5 and cut a release of some packages without upgrading generator testbenches to async for now.")

whitequark commented 1 month ago

Generator functions are deprecated in 0.5 and this is mentioned in the porting guide:

Convert simulator processes and testbenches to use the new async API.

However the deprecation fell through the cracks. (@wanda-phi do you think you can do another changelog backport PR?)