Skip to content

docs: add Bazel build instructions - #4

Closed
cw20050111-prog wants to merge 4 commits into
LinQuickDev:masterfrom
cw20050111-prog:docs-bazel-linquick-2991
Closed

docs: add Bazel build instructions#4
cw20050111-prog wants to merge 4 commits into
LinQuickDev:masterfrom
cw20050111-prog:docs-bazel-linquick-2991

Conversation

@cw20050111-prog

Copy link
Copy Markdown

What problem does this PR solve?

Issue Number: Fixes apache#2991

Problem Summary:

The getting started docs describe building bRPC with config_brpc.sh, CMake, vcpkg, and Docker, but they do not provide a Bazel build path even though the repository already contains Bazel and bzlmod support.

What is changed and the side effects?

Changed:

  • Add Bazel build instructions to English and Chinese getting started docs.
  • Document building //:brpc, building examples, running the echo example, and running Bazel tests.
  • Link the getting started docs to the Bazel dependency guide.
  • Update the Bazel support docs to prefer the verified bzlmod local checkout flow.
  • Keep legacy WORKSPACE usage documented separately.

Side effects:

  • Performance effects: None. Documentation-only change.

  • Breaking backward compatibility: None.


Check List:

Note: this is a docs-only change. The existing CI workflows ignore **.md changes, so CI may not be triggered automatically.

cw20050111-prog and others added 4 commits August 13, 2026 10:18
Official docs previously only covered config_brpc.sh and CMake, leaving
Bazel builders without guidance despite the repo already having full
Bazel/bzlmod support. Add a "Compile brpc with bazel" section (build,
run examples, run tests, and link to bazel_support.md for consuming
brpc as a dependency) to both docs/en and docs/cn getting_started.md,
with cross-reference links from the other OS sections matching the
existing cmake pattern.

Fixes apache#2991

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016u8i1npn8aMgNr5WiT97rt
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.

官方文档建议增加bazel的编译介绍,目前只有cmake和config_brpc.sh的步骤

1 participant