From 382aa9e6c35327df5ad405ffe61e9cd3e2bf2a86 Mon Sep 17 00:00:00 2001 From: YAMAMOTO Takashi Date: Tue, 6 May 2025 07:55:42 +0900 Subject: [PATCH] run_clang_format_diff: mention homebrew for clang-format installation (#4237) --- ci/coding_guidelines_check.py | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/ci/coding_guidelines_check.py b/ci/coding_guidelines_check.py index 5432080f1..43c366259 100644 --- a/ci/coding_guidelines_check.py +++ b/ci/coding_guidelines_check.py @@ -98,9 +98,19 @@ def run_clang_format_diff(root: Path, commits: str) -> bool: code before committing the PR, or it might fail to pass the CI check: 1. Install clang-format-14.0.0 - Normally we can install it by `sudo apt-get install clang-format-14`, - or download the package from https://github.com/llvm/llvm-project/releases - and install it + + You can download the package from + https://github.com/llvm/llvm-project/releases + and install it. + + For Debian/Ubuntu, we can probably use + `sudo apt-get install clang-format-14`. + + Homebrew has it as a part of llvm@14. + ```shell + brew install llvm@14 + /usr/local/opt/llvm@14/bin/clang-format + ``` 2. Format the C/C++ source file ``` shell