]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
CODING-STYLE.md: mention clang-format
authorEmil Velikov <emil.l.velikov@gmail.com>
Wed, 28 Jan 2026 20:09:17 +0000 (20:09 +0000)
committerLucas De Marchi <demarchi@kernel.org>
Tue, 3 Feb 2026 04:59:06 +0000 (22:59 -0600)
Copy/paste the section from CONTRIBUTING.md, completing the circle.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Reviewed-by: Lucas De Marchi <demarchi@kernel.org>
Link: https://github.com/kmod-project/kmod/pull/pull/417
Signed-off-by: Lucas De Marchi <demarchi@kernel.org>
CODING-STYLE.md

index ec861bc5cd23c251d2e4b12b4a4f76c51d237b91..da91c4eddd4b26b33e09afec0806034d62fa3b7f 100644 (file)
@@ -12,6 +12,7 @@ ASAP.
     + [Try to return/exit early](#try-to-return-exit-early)
     + [Avoid unnecessary initialization](#avoid-unnecessary-initialization)
     + [Sort the includes](#sort-the-includes)
+  * [Tooling - clang-format](#tooling-clang-format)
 
 
 # Inspiration
@@ -74,6 +75,8 @@ Example:
 
 ## Sort the includes
 
+> TODO: update our .clang-format to honour this rule
+
 Let the includes in the following order, separated by a new line:
 
     < system headers >
@@ -82,4 +85,11 @@ Let the includes in the following order, separated by a new line:
     < tool >
     "local headers"
 
+# Tooling - clang-format
+
+To ease and enforce the style a [.clang-format file](.clang-format) file is
+provided and ran in CI against all submissions.
+
+Make sure to run `git-clang-format` before submitting PRs/patches.
+
 [Linux Kernel]: https://www.kernel.org/doc/html/v6.9/process/coding-style.html