]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Update CONTRIBUTING.md for clang-format style
authorMilan Broz <gmazyland@gmail.com>
Mon, 26 Jan 2026 08:27:40 +0000 (09:27 +0100)
committerAlexandr Nedvedicky <sashan@openssl.org>
Tue, 3 Feb 2026 09:07:23 +0000 (10:07 +0100)
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 <gmazyland@gmail.com>
Reviewed-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Saša Nedvědický <sashan@openssl.org>
MergeDate: Tue Feb  3 09:07:35 2026
(Merged from https://github.com/openssl/openssl/pull/29755)

CONTRIBUTING.md

index 09416095e64d040deae0f1115e77c38584f0f7d0..5b28d8776a3c6c3930dce5b6b22a1cfc4936cc39 100644 (file)
@@ -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.