util: update README and rename CI configs[skip ci]

[jensen-yan]

Change-Id: If6f28d0ac57d57e07b716241136d106217123c72

Summary by CodeRabbit

• Documentation

  • Added comprehensive documentation covering configuration variants, their CI coverage, RTL alignment status, and performance specifications across different system configurations.

• Chores

  • Modified CI performance testing workflow to adjust branch-specific triggers and introduce manual dispatch capability for improved testing control and validation flexibility.

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

[coderabbitai]

Walkthrough

This pull request updates a GEM5 CI workflow configuration file for BTB performance testing, renaming the workflow and adjusting trigger conditions to target specific branches. Manual workflow dispatch is enabled. Corresponding documentation is added describing Kunminghu configuration variants and their CI coverage.

Changes

Cohort / File(s)	Summary
CI Workflow Configuration \.github/workflows/gem5-ideal-btb-0.3c.yml``	Workflow renamed to "gem5 Align BTB Performance Test(0.3c)", trigger restrictions updated (removed pull_request, push limited to xs-dev and *-align branches), workflow_dispatch with optional branch_name input added, uses reusable template with kmh_v3_btb.sh script and spec06-0.3c benchmark type.
Documentation README.md	Added section documenting Kunminghu configuration variants (kmhv2.py, kmhv3.py, idealkmhv3.py), their respective CI workflows, spec coverage, RTL alignment status, performance switch configuration, and branch-trigger semantics.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Workflow configuration changes are straightforward trigger and naming updates with no complex logic
• README additions are purely documentation without functional impact
• Changes are confined to single files in distinct domains (CI and docs)

Possibly related PRs

• Add kmhv3 #609: Overlaps in CI workflow and kmh_v3_btb.sh invocation targeting; both update workflow scripts and configuration for kmhv3 performance testing.

Suggested reviewers

• tastynoob

Poem

🐰 Workflows configured, branches aligned with care,
Benches tuned for specs with documentation fair,
Manual dispatch now welcome at the gate,
BTB tests flow smooth—0.3c's great!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately summarizes the main changes: updating the README with new documentation and renaming CI configuration files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch rename-ci

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

.github/workflows/gem5-ideal-btb-0.3c.yml (1)

8-13: The branch_name input is defined but never used in the workflow.

The workflow_dispatch input branch_name (lines 10-12) is not referenced anywhere. The reusable workflow call (lines 17-19) does not pass this input, so the workflow will execute against the current branch regardless of what the user provides. Either pass this input to the reusable workflow call or remove it.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6c2a92d and c24a733.

📒 Files selected for processing (2)

• .github/workflows/gem5-ideal-btb-0.3c.yml (1 hunks)
• README.md (1 hunks)

🔇 Additional comments (2)

.github/workflows/gem5-ideal-btb-0.3c.yml (1)

15-20: Workflow structure looks good.

The use of a reusable workflow template with explicit inputs (script_path and benchmark_type) is a clean, maintainable pattern. The trigger conditions are well-documented with the inline comment (line 5).

README.md (1)

49-61: Documentation for Kunminghu configuration variants is accurate and complete.

The "Kunminghu configuration variants and CI coverage" section (lines 49–61) is well-organized and all referenced CI workflows exist in the codebase with matching names:

• Line 53: "gem5 Performance Test (Tier 2 - Post-Merge)" is defined in .github/workflows/gem5-perf.yml ✓
• Line 54: "gem5 Align BTB Performance Test(0.3c)" is defined in .github/workflows/gem5-ideal-btb-0.3c.yml ✓
• Line 55: "gem5 Ideal BTB Performance Test" is defined in .github/workflows/gem5-ideal-btb-perf.yml ✓

The branch naming convention (*-align, *-perf) and score comparability caveats are properly documented.