Skip to content

util: UPDATE README for KMHV2-CONFIG[skip ci]#730

Merged
jueshiwenli merged 1 commit intoxs-devfrom
update-readme
Jan 26, 2026
Merged

util: UPDATE README for KMHV2-CONFIG[skip ci]#730
jueshiwenli merged 1 commit intoxs-devfrom
update-readme

Conversation

@jueshiwenli
Copy link
Copy Markdown
Collaborator

@jueshiwenli jueshiwenli commented Jan 24, 2026

Summary by CodeRabbit

  • Documentation
    • Updated README documentation in the Kunminghu configuration variants section with clarified guidance for KMH-V2 development. Users and contributors are now provided with specific direction on the appropriate development branch to use when working on KMH-V2 configuration-related features.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 24, 2026

📝 Walkthrough

Walkthrough

A 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

Cohort / File(s) Summary
Documentation Update
README.md
Added branching guidance for kmh-v2 development: users should switch to the KMH-V2-CONFIG branch if further development in this area is required

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐰 A branch path clarified, a guide made clear,
For kmhv2 voyagers drawing near,
KMH-V2-CONFIG awaits with care,
Documentation blooms, developers fare!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating the README documentation for the KMHV2-CONFIG branch reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

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

The text uses an em dash (–) instead of a hyphen (-) in "kmh-v2–related". This should use a standard hyphen for consistency.

Suggested change
- `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-v2related 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.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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).

@jueshiwenli jueshiwenli merged commit ccfe0d0 into xs-dev Jan 26, 2026
7 checks passed
@jueshiwenli jueshiwenli deleted the update-readme branch January 26, 2026 03:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants