From 21ba196d666b96987f4afc1c8af2666739469b85 Mon Sep 17 00:00:00 2001 From: David Hebbeker Date: Tue, 1 Apr 2025 21:06:05 +0200 Subject: [PATCH 1/2] Update dependency to clang-format to version 18 --- .github/workflows/clang-format-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/clang-format-check.yml b/.github/workflows/clang-format-check.yml index 33951bc63..4d2d3e7d4 100644 --- a/.github/workflows/clang-format-check.yml +++ b/.github/workflows/clang-format-check.yml @@ -14,6 +14,6 @@ jobs: - name: Run clang-format style check. uses: jidicula/clang-format-action@v4.11.0 with: - clang-format-version: '17' + clang-format-version: '18' fallback-style: 'none' From 71f72700f456eaa250e4fdc19d84da8848ae9323 Mon Sep 17 00:00:00 2001 From: David Hebbeker Date: Wed, 2 Apr 2025 08:22:50 +0200 Subject: [PATCH 2/2] Document that the code should be formatted according to a specific clang-format version --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25e20153e..20d6e11c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,6 +62,9 @@ Please document your code in Doxygen compatible syntax. Please format your changes using [ClangFormat](https://clang.llvm.org/docs/ClangFormat.html). A style configuration file is given: [`.clang-format`](.clang-format) +Unfortunately the output also depends on the clang-format version. +The reference version to be used is the one used by the verification scripts ("CI/CD pipeline"). + Although the standalone tool `clang-format` may be used, we recommend to integrate the formatting using a [plugin](https://firefox-source-docs.mozilla.org/code-quality/coding-style/format_cpp_code_with_clang-format.html#editor-plugins) for the editor of your choice. #### Naming convention