[ISSUE #5557]📝Update README with enhanced usage instructions and configuration details for RocketMQ Broker

[mxsm]

Which Issue(s) This PR Fixes(Closes)

Fixes #5557

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

• Documentation
  • Unified and improved broker help output documentation across platforms.
  • Added comprehensive Configuration section with environment variable guidance and priority details.
  • Introduced Exit Codes reference documenting broker termination states.
  • Expanded configuration documentation with detailed items and example broker.toml file.

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

[rocketmq-rust-bot]

🔊@mxsm 🚀Thanks for your contribution🎉！

💡CodeRabbit(AI) will review your code first🔥！

Note

🚨The code review suggestions from CodeRabbit are to be used as a reference only, and the PR submitter can decide whether to make changes based on their own judgment. Ultimately, the project management personnel will conduct the final code review💥.

[coderabbitai]

Walkthrough

This pull request updates the rocketmq-broker README with unified CLI usage instructions, replacing platform-specific guidance with standardized output examples. A new Configuration section is introduced detailing environment variables, configuration file loading behavior, and example broker.toml contents. An Exit Codes subsection is added to document broker termination states.

Changes

Cohort / File(s)	Summary
Documentation Updates rocketmq-broker/README.md	Consolidated Windows/Linux-specific help sections into unified usage output example; added explicit Configuration section with environment variable guidance, configuration file priority, and example broker.toml; introduced Exit Codes subsection for broker termination states (+164/-40 lines)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hopping through docs with glee,
Platform splits now unified to see,
Configuration secrets revealed so clear,
Exit codes mapped, no more fear!
A burrow of knowledge, organized neat,
Documentation done—hippity-complete! 📚✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly references issue #5557 and accurately describes the main change: updating README with enhanced usage instructions and configuration details for RocketMQ Broker.
Linked Issues check	✅ Passed	The PR addresses the linked issue #5557's objective to enhance README with improved usage instructions and configuration details for RocketMQ Broker, delivering consolidated documentation, configuration section, and exit codes subsection.
Out of Scope Changes check	✅ Passed	All changes are scoped to README.md documentation updates directly related to the linked issue; no out-of-scope code or unrelated modifications are present.
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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In @rocketmq-broker/README.md:
- Line 15: Replace the full-width colon in the heading string "**Run the
following command to see usage：**" with a standard ASCII colon, i.e. change "："
to ":" so the line reads "**Run the following command to see usage:**" to keep
punctuation consistent with the rest of the README.
- Line 23: Update the opening fenced code block in README.md to include a
language specifier (e.g., change the leading ``` to ```text) so the block
reading "Apache RocketMQ Broker Server implemented in Rust" is fenced as ```text
which satisfies MD040 and enables proper syntax highlighting.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ac81e6c and 0b3f6b7.

📒 Files selected for processing (1)

• rocketmq-broker/README.md

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

rocketmq-broker/README.md

23-23: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: Code Coverage
• GitHub Check: Build & Test (ubuntu-latest)
• GitHub Check: Build & Test (macos-latest)
• GitHub Check: auto-approve

🔇 Additional comments (3)

rocketmq-broker/README.md (3)

13-81: Unified CLI documentation is clear and well-structured.

The consolidated "Run Broker" section effectively replaces platform-specific instructions with a single, standardized help output. The command example (line 18) and startup instruction (line 80) are practical and correct.

---

83-139: Usage examples are comprehensive and practical.

The six scenarios—default configuration, custom config file, custom name server, printing configs, and environment variables—cover common use cases clearly. Commands are correct and examples account for platform differences (Windows set vs. Linux/macOS export) appropriately.

---

141-184: Configuration section provides essential guidance.

The configuration priority hierarchy (lines 145–150), environment variable documentation (lines 152–155), and example broker.toml (lines 162–175) align well with the CLI options shown in the help output. The exit codes subsection (lines 177–184) documents expected termination states, though verification against actual implementation behavior may be warranted.

Please verify that the documented exit codes (lines 177–184) accurately reflect the implementation, particularly exit code -2 for missing ROCKETMQ_HOME environment variable, which should align with the configuration loading behavior described in lines 33–37 of the help output.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Replace full-width colon with ASCII colon for consistency.

Line 15 uses a full-width colon (：) instead of the standard ASCII colon (:), which is inconsistent with English documentation conventions and other text in the file.

🔧 Proposed fix

-**Run the following command to see usage：**
+**Run the following command to see usage:**

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	**Run the following command to see usage：**
	**Run the following command to see usage:**

🤖 Prompt for AI Agents

In @rocketmq-broker/README.md at line 15, Replace the full-width colon in the
heading string "**Run the following command to see usage：**" with a standard
ASCII colon, i.e. change "：" to ":" so the line reads "**Run the following
command to see usage:**" to keep punctuation consistent with the rest of the
README.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Add language specifier to code fence.

The fenced code block lacks a language identifier. This violates markdown linting rules (MD040) and impacts syntax highlighting in rendered output.

🔧 Proposed fix

-```
+```text
 Apache RocketMQ Broker Server implemented in Rust

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

```

🧰 Tools

🪛 markdownlint-cli2 (0.18.1)

23-23: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents

In @rocketmq-broker/README.md at line 23, Update the opening fenced code block
in README.md to include a language specifier (e.g., change the leading ``` to
```text) so the block reading "Apache RocketMQ Broker Server implemented in
Rust" is fenced as ```text which satisfies MD040 and enables proper syntax
highlighting.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 38.51%. Comparing base (ac81e6c) to head (0b3f6b7).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5558   +/-   ##
=======================================
  Coverage   38.51%   38.51%           
=======================================
  Files         815      815           
  Lines      110613   110613           
=======================================
  Hits        42604    42604           
  Misses      68009    68009           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[rocketmq-rust-bot]

LGTM - All CI checks passed ✅