Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

spec: Fix formatting of example of memory port types. #2368

Merged
merged 2 commits into from
Sep 24, 2021
Merged

spec: Fix formatting of example of memory port types. #2368

merged 2 commits into from
Sep 24, 2021

Conversation

richardxia
Copy link
Member

@richardxia richardxia commented Sep 23, 2021 •
edited
Loading

8abf308 reordered the fields, but it
unintentionally placed a closing brace before the actual end of the write
port type. This moves the brace to the end of the port.

Before

(Note that the page break happens at the worst possible position, since it happens to be right where stray closing brace is)

Screen Shot 2021-09-23 at 4 24 53 PM

After

Screen Shot 2021-09-23 at 4 46 49 PM

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • 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

  • bug fix
  • documentation

API Impact

No API changes (unless if people treat typos in the spec too literally)

Backend Code Generation Impact

No code changes.

Desired Merge Strategy

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

Release Notes

Fixes a minor typo in the FIRRTL language memory specification document, where a closing brace was placed before the actual end of the write port type.

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?

@richardxia
spec: Fix formatting of example of memory port types.
4a484bb 
8abf308 reordered the fields, but it
unintentionally placed a closing brace before the actual end of the
write port type. This moves the brace to the end of the port.
@CLAassistant
Copy link

CLAassistant commented Sep 23, 2021 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

seldridge
seldridge approved these changes Sep 24, 2021
View reviewed changes
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

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

Whoops. Thanks for the fix, @richardxia!

@seldridge seldridge added this to the 1.2.x milestone Sep 24, 2021
@seldridge seldridge added the Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI. label Sep 24, 2021
@mergify mergify bot merged commit b2cae19 into chipsalliance:master Sep 24, 2021
mergify bot pushed a commit that referenced this pull request Sep 24, 2021
@richardxia
spec: Fix formatting of example of memory port types. (#2368)
0284373 
8abf308 reordered the fields, but it
unintentionally placed a closing brace before the actual end of the
write port type. This moves the brace to the end of the port.

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

# Conflicts:
#	spec/spec.pdf
@mergify mergify bot mentioned this pull request Sep 24, 2021
Merged
mergify bot pushed a commit that referenced this pull request Sep 24, 2021
@richardxia
spec: Fix formatting of example of memory port types. (#2368)
311ed3d 
8abf308 reordered the fields, but it
unintentionally placed a closing brace before the actual end of the
write port type. This moves the brace to the end of the port.

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

# Conflicts:
#	spec/spec.pdf
@mergify mergify bot mentioned this pull request Sep 24, 2021
Merged
mergify bot pushed a commit that referenced this pull request Sep 24, 2021
@richardxia
spec: Fix formatting of example of memory port types. (#2368)
f56d355 
8abf308 reordered the fields, but it
unintentionally placed a closing brace before the actual end of the
write port type. This moves the brace to the end of the port.

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

# Conflicts:
#	spec/spec.pdf
@mergify mergify bot mentioned this pull request Sep 24, 2021
Merged
@mergify mergify bot added the Backported This PR has been backported to marked stable branch label Sep 24, 2021
@richardxia richardxia deleted the fix-spec-memory-code-example branch September 24, 2021 01:41
mergify bot added a commit that referenced this pull request Sep 24, 2021
@mergify @richardxia
spec: Fix formatting of example of memory port types. (#2368) (#2369)
62db6a4 
8abf308 reordered the fields, but it
unintentionally placed a closing brace before the actual end of the
write port type. This moves the brace to the end of the port.

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

# Conflicts:
#	spec/spec.pdf

Co-authored-by: Richard Xia <rxia@sifive.com>
mergify bot added a commit that referenced this pull request Sep 24, 2021
@mergify @richardxia
spec: Fix formatting of example of memory port types. (#2368) (#2370)
5cc2b2c 
8abf308 reordered the fields, but it
unintentionally placed a closing brace before the actual end of the
write port type. This moves the brace to the end of the port.

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

# Conflicts:
#	spec/spec.pdf

Co-authored-by: Richard Xia <rxia@sifive.com>
mergify bot added a commit that referenced this pull request Sep 24, 2021
@mergify @richardxia
spec: Fix formatting of example of memory port types. (#2368) (#2371)
af5d544 
8abf308 reordered the fields, but it
unintentionally placed a closing brace before the actual end of the
write port type. This moves the brace to the end of the port.

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

# Conflicts:
#	spec/spec.pdf

Co-authored-by: Richard Xia <rxia@sifive.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@seldridge seldridge seldridge approved these changes

Assignees
No one assigned
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
Milestone
1.2.x
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@richardxia @CLAassistant @seldridge