Skip to content
This repository has been archived by the owner on Aug 20, 2024. It is now read-only.

Make MultiTargetAnnotation.targets a def #1969

Merged
merged 3 commits into from
Nov 17, 2020

Conversation

jackkoenig
Copy link
Contributor

@jackkoenig jackkoenig commented Nov 17, 2020

This enables the annotation writer to choose their own underlying data structure.

Pleasantly surprising to me, this is binary compatible so I think we should backport.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • [NA] Did you update the FIRRTL spec to include every new feature/behavior?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you state the API impact?
  • Did you specify the code generation impact?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • code cleanup

API Impact

It loosens it so that implementers of MultiTargetAnnotation don't have to have targets be a val, but this is backwards compatible.

Backend Code Generation Impact

No impact

Desired Merge Strategy

  • Squash

Release Notes

Change MultiTargetAnnotation.targets from a val to a def

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels?
  • Did you mark the proper milestone (1.2.x, 1.3.0, 1.4.0) ?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you mark as Please Merge?

This enables the annotation writer to choose their own underlying data structure
@jackkoenig jackkoenig added this to the 1.2.X milestone Nov 17, 2020
@jackkoenig jackkoenig requested a review from a team as a code owner November 17, 2020 00:09
@jackkoenig jackkoenig requested review from albert-magyar and removed request for a team November 17, 2020 00:09
Copy link
Contributor

@albert-magyar albert-magyar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Scaladoc changes look good, thanks!

@jackkoenig jackkoenig added the Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI. label Nov 17, 2020
@mergify mergify bot merged commit cd845bd into master Nov 17, 2020
mergify bot pushed a commit that referenced this pull request Nov 17, 2020
* Make MultiTargetAnnotation.targets a def

This enables the annotation writer to choose their own underlying data structure

* Update MultiTargetAnnotation ScalaDoc

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit cd845bd)

# Conflicts:
#	src/main/scala/firrtl/annotations/Annotation.scala
mergify bot pushed a commit that referenced this pull request Nov 17, 2020
* Make MultiTargetAnnotation.targets a def

This enables the annotation writer to choose their own underlying data structure

* Update MultiTargetAnnotation ScalaDoc

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit cd845bd)

# Conflicts:
#	src/main/scala/firrtl/annotations/Annotation.scala
mergify bot pushed a commit that referenced this pull request Nov 17, 2020
* Make MultiTargetAnnotation.targets a def

This enables the annotation writer to choose their own underlying data structure

* Update MultiTargetAnnotation ScalaDoc

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit cd845bd)
@mergify mergify bot added the Backported This PR has been backported to marked stable branch label Nov 17, 2020
mergify bot added a commit that referenced this pull request Nov 17, 2020
* Make MultiTargetAnnotation.targets a def

This enables the annotation writer to choose their own underlying data structure

* Update MultiTargetAnnotation ScalaDoc

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit cd845bd)

Co-authored-by: Jack Koenig <[email protected]>
@jackkoenig jackkoenig deleted the multitargetannotation-def-targets branch November 18, 2020 19:04
mergify bot added a commit that referenced this pull request Nov 24, 2020
* Make MultiTargetAnnotation.targets a def (#1969)

* Make MultiTargetAnnotation.targets a def

This enables the annotation writer to choose their own underlying data structure

* Update MultiTargetAnnotation ScalaDoc

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit cd845bd)

# Conflicts:
#	src/main/scala/firrtl/annotations/Annotation.scala

* Resolve merge conflicts

Co-authored-by: Jack Koenig <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
mergify bot added a commit that referenced this pull request Nov 24, 2020
* Make MultiTargetAnnotation.targets a def (#1969)

* Make MultiTargetAnnotation.targets a def

This enables the annotation writer to choose their own underlying data structure

* Update MultiTargetAnnotation ScalaDoc

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit cd845bd)

# Conflicts:
#	src/main/scala/firrtl/annotations/Annotation.scala

* Resolve merge conflicts

Co-authored-by: Jack Koenig <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants