util: UPDATE README for KMHV2-CONFIG[skip ci]#730
Conversation
📝 WalkthroughWalkthroughA documentation update to the README file that adds clarification for the Kunminghu configuration variants section. Specifically, the kmhv2.py configuration bullet point now includes guidance to switch to the KMH-V2-CONFIG branch if further kmh-v2 related development is needed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR updates the README documentation to inform users that further development work on the Kunminghu V2 configuration should be done on the KMH-V2-CONFIG branch rather than the main branch.
Changes:
- Added a note to the kmhv2.py configuration description directing developers to switch to the KMH-V2-CONFIG branch for further kmh-v2-related development work
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| We maintain three main Kunminghu configuration scripts to mirror RTL progress and performance targets. Each is covered by a distinct CI workflow so their results are easy to track (SPECCPU06 coverage shown in parentheses). | ||
|
|
||
| - `configs/example/kmhv2.py`: Kunminghu V2 baseline; used by the Tier 2 post-merge regression workflow `gem5 Performance Test (Tier 2 - Post-Merge)` (spec06-0.8c). | ||
| - `configs/example/kmhv2.py`: Kunminghu V2 baseline; used by the Tier 2 post-merge regression workflow `gem5 Performance Test (Tier 2 - Post-Merge)` (spec06-0.8c). If further development under the kmh-v2–related configuration is required, please switch to the KMH-V2-CONFIG branch. |
There was a problem hiding this comment.
The text uses an em dash (–) instead of a hyphen (-) in "kmh-v2–related". This should use a standard hyphen for consistency.
| - `configs/example/kmhv2.py`: Kunminghu V2 baseline; used by the Tier 2 post-merge regression workflow `gem5 Performance Test (Tier 2 - Post-Merge)` (spec06-0.8c). If further development under the kmh-v2–related configuration is required, please switch to the KMH-V2-CONFIG branch. | |
| - `configs/example/kmhv2.py`: Kunminghu V2 baseline; used by the Tier 2 post-merge regression workflow `gem5 Performance Test (Tier 2 - Post-Merge)` (spec06-0.8c). If further development under the kmh-v2-related configuration is required, please switch to the KMH-V2-CONFIG branch. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 53: Fix the typographical inconsistency in README.md by replacing the
en-dash in the phrase "kmh-v2–related" with a normal hyphen so it reads
"kmh-v2-related"; locate the sentence referencing `configs/example/kmhv2.py` and
the phrase "kmh-v2–related" and update the punctuation accordingly (optionally,
you may also add a link to the KMH-V2-CONFIG branch for easier navigation).
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.