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 for ICache #3001

Merged
merged 2 commits into from
Aug 11, 2022
Merged

Add documentation for ICache #3001

merged 2 commits into from
Aug 11, 2022

Conversation

midnighter95
Copy link
Contributor

@midnighter95 midnighter95 commented Jun 27, 2022 •
edited
Loading

Related issue: Documentation

Type of change: other enhancement

Impact: no functional change

Development Phase: implementation

Release Notes

Add documentation for Rocket-Chip Instruction Cache, based on a612389.
My work are listed as followed:

  1. Fix typo
  2. Reorganization to improve readablity
  3. Delete some inline comments and 'todo' to avoid presenting too much details

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jun 27, 2022 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: sequencer / name: Jiuyang Liu (a612389)
  • ✅ login: midnighter95 / name: Yanqi Yang (d5f5694)

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 1, 2022 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@midnighter95
Copy link
Contributor Author

Ask for review @sequencer @jerryz123

@sequencer
Copy link
Member

Actually, most of documentation are cherry-picking from my previous documentation PR #2761, Thanks @midnighter95 to rebase them to master.
Since i was the author of the PR, I'm not qualified to review my own codes. So I will only comment on this PR, but let @jerryrzhao to decide when can we get this PR into master.

@midnighter95 midnighter95 changed the title Add document for ICache Add documentation for ICache Jul 11, 2022
jerryz123
jerryz123 requested changes Jul 13, 2022
View reviewed changes
Copy link
Contributor

@jerryz123 jerryz123 left a comment

Choose a reason for hiding this comment

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

Overall this looks pretty good.

I see some formatting issues of the ASCII diagrams, but maybe that is just an issue with my browser.

src/main/scala/rocket/ICache.scala Outdated Show resolved Hide resolved
src/main/scala/rocket/ICache.scala Outdated Show resolved Hide resolved
src/main/scala/rocket/ICache.scala Outdated Show resolved Hide resolved
src/main/scala/rocket/ICache.scala Outdated Show resolved Hide resolved
src/main/scala/rocket/ICache.scala Outdated Show resolved Hide resolved
src/main/scala/rocket/ICache.scala Outdated Show resolved Hide resolved
src/main/scala/rocket/ICache.scala Outdated Show resolved Hide resolved
src/main/scala/rocket/ICache.scala Outdated Show resolved Hide resolved
src/main/scala/rocket/ICache.scala Show resolved Hide resolved
src/main/scala/rocket/ICache.scala Outdated Show resolved Hide resolved
@sequencer sequencer mentioned this pull request Jul 13, 2022
Closed
@midnighter95 midnighter95 requested a review from jerryz123 July 25, 2022 04:43
@sequencer sequencer enabled auto-merge (squash) August 11, 2022 11:00
@sequencer sequencer merged commit f6e0f0e into chipsalliance:master Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sequencer sequencer sequencer left review comments

@jerryz123 jerryz123 jerryz123 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@midnighter95 @sequencer @jerryz123