util: update README and docs[skip ci]

[jensen-yan]

aviod use xiangshan.py

Change-Id: I1de63bbcb43481fd740c229b6aab4cc31d385618

Summary by CodeRabbit

• Documentation

  • Updated all usage examples and tutorials to reference kmhv3.py as the recommended entry point instead of xiangshan.py.
  • Updated shell script references from kmh_6wide.sh to kmh_v3_btb.sh across configuration and execution documentation.

• Deprecation

  • Added deprecation warning for legacy xiangshan.py entry point to direct users to maintained configurations.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR replaces deprecated xiangshan.py entrypoint references with the newer kmhv3.py configuration across documentation and code. It adds a deprecation warning to legacy xiangshan.py usage and updates default script references from kmh_6wide.sh to kmh_v3_btb.sh.

Changes

Cohort / File(s)	Summary
Deprecation Warning configs/common/xiangshan.py	Adds module-level _warned_deprecated_entrypoint flag and _warn_if_deprecated_xiangshan_entrypoint() function to emit a one-time deprecation warning when xiangshan.py entrypoint is detected, guiding users toward maintained kmhv3.py.
Primary Documentation README.md, docs/quick_start.md, docs/Gem5_Docs/top/gem5_tutorial.md	Replaces default configuration references from xiangshan.py to kmhv3.py and script references from kmh_6wide.sh to kmh_v3_btb.sh in usage examples, commands, and descriptions. Updates About section with expanded technical overview.
Frontend & Top-Level Guides docs/Gem5_Docs/frontend/..., docs/Gem5_Docs/top/gem5_Top.md, docs/Gem5_Docs/top/gem5_learn.md, docs/Gem5_Docs/top/NEMU_XS-GEM5_usage.md, docs/Gem5_Docs/top/run_checkpoint.md, docs/Gem5_Docs/top/vscode_guide.md	Updates gem5 invocation commands to use kmhv3.py instead of xiangshan.py; replaces kmh_6wide.sh with kmh_v3_btb.sh in checkpoint execution examples. Adds alternative idealkmhv3.py references where applicable.
Tool & Analysis Documentation docs/tools/alignToRTL/PerfCCT_usage.md, docs/tools/alignToRTL/align.md, docs/tools/spec/spec06/libquantum.md, docs/tools/spec/spec_analysis_method.md, docs/tools/microbenchmark/mini-bench_IsaDiffDepen.md	Replaces configuration file paths from xiangshan.py to kmhv3.py in SPEC and analysis tool documentation. align.md introduces FakeL3 component and adjusts architectural config options (L3 banking, prefetcher settings).
Introduction & Reference docs/introduction.md	Updates preferred processor configuration entry point from xiangshan.py to kmhv3.py while retaining xiangshan.py as historical reference.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• util: update README and rename CI configs[skip ci] #647 — Coordinated renames and documentation updates switching references to kmhv3 and kmh_v3_btb.sh scripts across config and CI usage.
• Add kmhv3 #609 — Introduces the kmhv3.py configuration as the new primary entrypoint with accompanying deprecation guidance for legacy xiangshan.py.
• cpu-o3: simplify fetch， only support decoupled BTB mode #721 — Modifies configs/common/xiangshan.py initialization pathway to enforce BTB-only branch predictor configuration.

Suggested reviewers

• happy-lx

Poem

🐰 The configs hop to a fresher way,
Old xiangshan paths bid farewell today,
kmhv3 now leads with a warning so kind,
Deprecated paths leave no one behind,
Updated scripts make the simulations fly! ✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The title 'util: update README and docs[skip ci]' is vague and generic. It mentions updating documentation but provides no specifics about what the changes accomplish or what the documentation is being updated to recommend.	Revise the title to be more specific about the primary change, such as: 'Deprecate xiangshan.py entrypoint and update docs to recommend kmhv3.py' or 'Update docs to prefer kmhv3.py over xiangshan.py as primary entry point'.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-docs

Tip

🧪 Unit Test Generation v2 is now available!

We have significantly improved our unit test generation capabilities.

To enable: Add this to your .coderabbit.yaml configuration:

reviews:
  finishing_touches:
    unit_tests:
      enabled: true

Try it out by using the @coderabbitai generate unit tests command on your code files or under ✨ Finishing Touches on the walkthrough!

Have feedback? Share your thoughts on our Discord thread!

---

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)

docs/tools/alignToRTL/align.md (1)

182-184: ⚠️ Potential issue | 🟡 Minor

Remove stray CR (^M) artifacts from the diff snippet.

Those literal CR characters will break copy/paste and can corrupt the patch when applied. Please remove them so the snippet is clean.

🤖 Fix all issues with AI agents

In `@docs/Gem5_Docs/top/gem5_Top.md`:
- Line 130: The phrase "kmhv3.py 接受 --generic-rv-cpt" is abrupt; change it to a
full sentence such as "The kmhv3.py script accepts the --generic-rv-cpt option."
Update the line mentioning kmhv3.py and --generic-rv-cpt to include a verb and
optionally article ("the"/"script") so it reads as a complete, readable
sentence.

🧹 Nitpick comments (1)

docs/tools/alignToRTL/PerfCCT_usage.md (1)

57-57: Documentation correctly updated to use kmhv3.py.

The sample command now references the maintained entrypoint. Note: Static analysis flagged hard tabs in this line—consider replacing them with spaces for consistent formatting if the project style guide requires it.