chisel icon indicating copy to clipboard operation
chisel copied to clipboard
verified publisher icon chipsalliance

Deprecate Chisel._ Compatibility Mode

Open mwachs5 opened this issue 3 years ago • 6 comments

Contributor Checklist

  • [ ] Did you add Scaladoc to every public function/method?
  • [ ] Did you add at least one test demonstrating the PR?
  • [x] Did you delete any extraneous printlns/debugging code?
  • [x] Did you specify the type of improvement?
  • [ ] Did you add appropriate documentation in docs/src?
    • NO * -- what to say in the docs about this
  • [x] Did you state the API impact?
  • [x] Did you specify the code generation impact?
  • [x] Did you request a desired merge strategy?
  • [x] Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • code cleanup
  • removing an API

API Impact

This would deprecate all of Chisel._ code. Thus, anyone doing import Chisel._ will see a slew of deprecation warnings.

I also deleted APIs from Chisel._ which were already deprecated.

Backend Code Generation Impact

No impact on backend code generation.

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference.

Release Notes

  • Deprecate the Chisel._ Compatibility Mode package.
  • Deleted APIs from Chisel._ which were already deprecated.

Reviewer Checklist (only modified by reviewer)

  • [ ] Did you add the appropriate labels?
  • [ ] Did you mark the proper milestone (Bug fix: 3.4.x, [small] API extension: 3.5.x, API modification or big change: 3.6.0)?
  • [ ] Did you review?
  • [ ] Did you check whether all relevant Contributor checkboxes have been checked?
  • [ ] Did you do one of the following when ready to merge:
    • [ ] Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • [ ] Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

mwachs5 avatar Aug 09 '22 17:08 mwachs5

I also moved log2Up and log2Down into chisel3.util since it seems we don't have a story for getting rid of them

mwachs5 avatar Aug 09 '22 17:08 mwachs5

What's the timeline on removing Chisel2 compat entirely?

jerryz123 avatar Aug 09 '22 23:08 jerryz123

?!

382

edwardcwang avatar Aug 09 '22 23:08 edwardcwang

What's the timeline on removing Chisel2 compat entirely?

Deprecate in 3.6 and remove in 3.7.

jackkoenig avatar Aug 10 '22 16:08 jackkoenig

Overall this looks great. Per docs, can you mention that the chisel3-vs-chisel2 doc only applies to Chisel 3.6 and below? https://github.com/chipsalliance/chisel3/blob/master/docs/src/appendix/chisel3-vs-chisel2.md

Also there is a "troubleshooting" doc that really seems like it should be folded in to chisel3-vs-chisel2, but maybe that should be a separate, backported PR: https://github.com/chipsalliance/chisel3/blob/master/docs/src/cookbooks/troubleshooting.md

jackkoenig avatar Aug 11 '22 00:08 jackkoenig

This will not be merged until we have the Directional Bulk Connect :<>= operator merged

mwachs5 avatar Aug 15 '22 19:08 mwachs5

Overall this looks great. Per docs, can you mention that the chisel3-vs-chisel2 doc only applies to Chisel 3.6 and below? https://github.com/chipsalliance/chisel3/blob/master/docs/src/appendix/chisel3-vs-chisel2.md

Done

Also there is a "troubleshooting" doc that really seems like it should be folded in to chisel3-vs-chisel2, but maybe that should be a separate, backported PR: https://github.com/chipsalliance/chisel3/blob/master/docs/src/cookbooks/troubleshooting.md

Agree. not going to touch this one for now.

mwachs5 avatar Dec 05 '22 19:12 mwachs5