Format C++ code in the BE and Cloud modules using the project's clang-format v16 rules. Use the provided scripts to fix formatting or check for violations without changing files, then review the resulting differences before committing.
Fix BE (C++) code formatting issues using clang-format
Review the instructions the agent will receive before you install.
Fix C++ code formatting issues in the BE and Cloud modules using the project's clang-format configuration (v16).
You need to confirm that the major version of the called clang-format is 16. If the current environment's default does not meet this requirement, try the following:
.vscode/settings.json exists, use the clang-format.executable item in it..vscode/settings.json from the main directory.PATH environment variable, the current directory, and the main directory's custom_env.sh. Look for a clang-format with the major version number 16 in that path and its parent directory.Run the project's formatting script, which enforces clang-format v16:
build-support/clang-format.sh
This formats all C++ files under be/src, be/test, cloud/src, cloud/test in-place, respecting .clang-format and .clang-format-ignore.
Important: Always use this script instead of invoking clang-format directly. The script checks that clang-format version 16 is installed and exits with an error if the wrong version is found. Using a different version will produce inconsistent formatting.
To verify formatting without modifying files:
build-support/check-format.sh
This outputs a diff of any formatting violations and exits non-zero if there are any.
After running clang-format.sh, review the changes with git diff to verify only formatting was changed, then stage and commit.
| File | Purpose |
|---|---|
.clang-format | Main formatting rules (Google-based, 100 col, 4-space indent) |
.clang-format-ignore | Files excluded from formatting (third-party, generated) |
build-support/run_clang_format.py | Python wrapper for parallel execution |
The following are excluded from formatting (see .clang-format-ignore):
be/src/apache-orc/*, be/src/clucene/*, be/src/gutil/*be/src/glibc-compatibility/*cloud/src/common/defer.h| Problem | Solution |
|---|---|
clang-format not found | Install clang-format v16 or set CLANG_FORMAT_BINARY env var |
version is not 16 | Install clang-format v16; on macOS: brew install llvm@16 |
| Files not being formatted | Check .clang-format-ignore for exclusions |
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Run clang-tidy static analysis, which checks code without executing it, on added or modified BE and Cloud C++ files. Focus diagnostics on changed lines, investigate bug, performance, and readability warnings, and verify fixes with another check.
Review Doris code changes using project-specific checklists for data correctness, concurrency, memory safety, compatibility, performance, and tests. Trace related code paths and explain findings with concrete failure scenarios, using query plan trees when reviewing optimizer behavior.
Prepare a clean Doris package and run Docker regression tests, which check whether changes break existing behavior. Restore configuration and startup files from Git, build the test image, and investigate failures using configuration checks and runtime logs.
Diagnoses and fixes Java style violations in the FE module using Checkstyle, a tool that checks coding rules. It interprets errors, applies the project's formatting and import restrictions, and reruns checks to verify fixes.