From: Milan Broz Date: Mon, 26 Jan 2026 08:27:40 +0000 (+0100) Subject: Update CONTRIBUTING.md for clang-format style X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3cef0d98aa9145bd5c9eda1cf39ae58b685d8742;p=thirdparty%2Fopenssl.git Update CONTRIBUTING.md for clang-format style The old Perl tool no longer exists, mention clang-format and utilities. Fixes: https://github.com/openssl/project/issues/1770 Signed-off-by: Milan Broz Reviewed-by: Eugene Syromiatnikov Reviewed-by: Tomas Mraz Reviewed-by: Saša Nedvědický MergeDate: Tue Feb 3 09:07:35 2026 (Merged from https://github.com/openssl/openssl/pull/29755) --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09416095e64..5b28d8776a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,8 +77,13 @@ guidelines: 4. Code provided should follow our [coding style] and [documentation policy] and compile without warnings. - There is a [Perl tool](util/check-format.pl) that helps - finding code formatting mistakes and other coding style nits. + Consistent formatting is enforced by using `clang-format` with configuration + stored in [.clang-format](.clang-format). OpenSSL uses `WebKit` style. + You can configure git pre-commit to automatically reformat your code with + [.pre-commit-config.yaml](.pre-commit-config.yaml) configuration. + There is also a [Perl tool](util/reformat-patches.sh) to help with + reformatting existing patches. + Where `gcc` or `clang` is available, you should use the `--strict-warnings` `Configure` option. OpenSSL compiles on many varied platforms: try to ensure you only use portable features.