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

Add documentation guide about memory initialization #1850

Merged
merged 2 commits into from
Apr 7, 2021
Merged

Add documentation guide about memory initialization #1850

merged 2 commits into from
Apr 7, 2021

Conversation

carlosedp
Copy link
Contributor

@carlosedp carlosedp commented Apr 1, 2021 •
edited by mwachs5
Loading

This PR adds documentation to the user guide on using memory initialization.

Contributor Checklist

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

  • documentation

API Impact

No API impact, added new documentation for memory initialization.

Backend Code Generation Impact

No backend code generation impacts.

Desired Merge Strategy

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

Release Notes

Added documentation on inline memory initialization and usage on synthesis.

Reviewer Checklist (only modified by reviewer)

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

@carlosedp carlosedp force-pushed the mem-docs branch 2 times, most recently from 9984413 to c857b73 Compare April 5, 2021 13:01
@carlosedp
Copy link
Contributor Author

Fixed. I don't think the error has much to do with what I changed:

info: Compiling 49 files to /__w/chisel3/chisel3/docs/generated
error: /__w/chisel3/chisel3/docs/src/explanations/memories.md:44:24: not found: value counter
      sinTable(amp, n)(counter(n.U))

@mwachs5
Copy link
Contributor

mwachs5 commented Apr 5, 2021

I don't think the error has much to do with what I changed:

It may be related to this change: https://github.com/chipsalliance/chisel3/pull/1850/files#diff-67672ef478f6d0824ac8ef3779a01f203d627b02dd68e08bc73f3ac3bf501abaR34

@carlosedp
Copy link
Contributor Author

Found it... was the space that was removed. Thanks Megan!

@carlosedp carlosedp requested a review from mwachs5 April 5, 2021 19:15
@carlosedp carlosedp requested a review from mwachs5 April 5, 2021 20:33
@mwachs5
Copy link
Contributor

mwachs5 commented Apr 5, 2021

thanks @carlosedp , will do another pass on this tonight

@carlosedp
Copy link
Contributor Author

Ping @mwachs5 :)

mwachs5
mwachs5 reviewed Apr 7, 2021
View reviewed changes
Copy link
Contributor

@mwachs5 mwachs5 left a comment

Choose a reason for hiding this comment

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

Looking good! I'll approve if this round is addressed!

@mwachs5
Copy link
Contributor

mwachs5 commented Apr 7, 2021 •
edited
Loading

somehow you lost the PR template... can you copy into your original comment (at the top) and fill out the Contributor checklist? SO I can fill out the reviewer checklist? https://raw.githubusercontent.com/chipsalliance/chisel3/master/.github/PULL_REQUEST_TEMPLATE.md

@carlosedp
Copy link
Contributor Author

somehow you lost the PR template... can you copy into your original comment (at the top) and fill out the Contributor checklist? SO I can fill out the reviewer checklist? master/.github/PULL_REQUEST_TEMPLATE.md (raw)

Done!

@carlosedp carlosedp requested a review from mwachs5 April 7, 2021 18:08
@mwachs5 mwachs5 added this to the 3.4.x milestone Apr 7, 2021
@mwachs5 mwachs5 added the Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI. label Apr 7, 2021
mwachs5
mwachs5 approved these changes Apr 7, 2021
View reviewed changes
Copy link
Contributor

@mwachs5 mwachs5 left a comment

Choose a reason for hiding this comment

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

Thanks!

@mergify mergify bot merged commit e0da5ae into chipsalliance:master Apr 7, 2021
mergify bot pushed a commit that referenced this pull request Apr 7, 2021
@carlosedp
Add documentation guide about memory initialization (#1850)
875a85b 
* Add documentation guide about memory initialization

* Move information to experimental and add ref

(cherry picked from commit e0da5ae)
@mergify mergify bot mentioned this pull request Apr 7, 2021
Merged
@mergify mergify bot added the Backported This PR has been backported label Apr 7, 2021
mergify bot added a commit that referenced this pull request Apr 8, 2021
@mergify @carlosedp
Add documentation guide about memory initialization (#1850) (#1855)
1361f2b 
* Add documentation guide about memory initialization

* Move information to experimental and add ref

(cherry picked from commit e0da5ae)

Co-authored-by: Carlos Eduardo <me@carlosedp.com>
@MAFOR-TECH MAFOR-TECH mentioned this pull request Oct 24, 2021
Closed
@sequencer sequencer mentioned this pull request Nov 8, 2021
Closed
jackkoenig pushed a commit that referenced this pull request Feb 28, 2023
@scala-steward @mergify
Update scalacheck-1-14, ... to 3.2.1.0 (#1850)
ededfcf 
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@debs-sifive debs-sifive debs-sifive left review comments

@mwachs5 mwachs5 mwachs5 approved these changes

Assignees
No one assigned
Labels
Backported This PR has been backported Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI.
Projects
None yet
Milestone
3.4.x
Development

Successfully merging this pull request may close these issues.
3 participants
@carlosedp @mwachs5 @debs-sifive