This repository has been archived by the owner on Aug 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 177
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sequencer
added
API Deprecation
Changing the API but with proper deprecation
Backport
Automated backport, please consider for minor release
labels
Apr 24, 2021
ekiwi
reviewed
Apr 24, 2021
src/main/scala/firrtl/passes/memlib/CreateMemoryAnnotations.scala
Outdated
Show resolved
Hide resolved
sequencer
force-pushed
the
memlib_deprecation
branch
from
April 24, 2021 03:54
00cad84
to
6224e9f
Compare
jackkoenig
reviewed
Apr 26, 2021
src/main/scala/firrtl/passes/memlib/CreateMemoryAnnotations.scala
Outdated
Show resolved
Hide resolved
sequencer
force-pushed
the
memlib_deprecation
branch
2 times, most recently
from
April 27, 2021 01:41
da4d062
to
0f336cf
Compare
jackkoenig
approved these changes
Apr 27, 2021
sequencer
force-pushed
the
memlib_deprecation
branch
from
April 27, 2021 01:50
0f336cf
to
4da4609
Compare
sequencer
added
the
Merge Commit Please
This branch has useful history, please merge with a merge commit
label
Apr 27, 2021
sequencer
added
Merge Commit Please
This branch has useful history, please merge with a merge commit
Please Merge
Accepted PRs that are ready to be merged. Useful when waiting on CI.
and removed
Merge Commit Please
This branch has useful history, please merge with a merge commit
Backport
Automated backport, please consider for minor release
labels
Apr 27, 2021
mergify
bot
added
the
Backported
This PR has been backported to marked stable branch
label
Apr 27, 2021
mergify bot
added a commit
that referenced
this pull request
Apr 27, 2021
(cherry picked from commit 33c0b43) Co-authored-by: Jiuyang Liu <[email protected]>
jackkoenig
reviewed
May 10, 2021
Comment on lines
+9
to
11
@deprecated("CreateMemoryAnnotations will not take reader: Option[YamlFileReader] as argument since 1.5.", "FIRRTL 1.4") | ||
class CreateMemoryAnnotations(reader: Option[YamlFileReader]) extends Transform with DependencyAPIMigration { | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should deprecate constructors instead of classes so that people can still have dependencies on them.
class CreateMemoryAnnotations private (reader: Option[YamlFileReader], dummy: Int) extends Transform with DependencyAPIMigration {
@deprecated("CreateMemoryAnnotations will not take reader: Option[YamlFileReader] as argument since 1.5.", "FIRRTL 1.4")
def this(reader: Option[YamlFileReader]) = new CreateMemoryAnnotations(reader, 0)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’ll add another PR to 3.4.x
:
Not to deprecate entire class, but only deprecate only this constructor.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
API Deprecation
Changing the API but with proper deprecation
Backported
This PR has been backported to marked stable branch
Please Merge
Accepted PRs that are ready to be merged. Useful when waiting on CI.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contributor Checklist
Type of Improvement
API Impact
deprecate APIs:
CreateMemoryAnnotations
ConfWriter
ReplSeqMem
ReplaceMemMacros and its functions:
.memToBundle
.memToFlattenBundle
.createMemModule
.defaultConnects
.maskBits
.adaptReader
.adaptWriter
.adaptReadWriter
.constructNameMap
.updateMemStmts
.updateMemMods
Backend Code Generation Impact
None
Desired Merge Strategy
Release Notes
Reviewer Checklist (only modified by reviewer)
Please Merge
?