Skip to contentSkip to conversation

scripts: Introduce a default git.orderFile

RFC PATCH New Leonardo Bras 1 participant 1 message Dec 11, 2023 Kbuild

lore
Share & tools
lore
#0 lore raw

RFC PATCH v6 1/1 scripts: Introduce a default git.orderFile

When reviewing patches, it looks much nicer to have some changes shown before others, which allow better understanding of the patch before the the .c files reviewing.

Introduce a default git.orderFile, in order to help developers getting the best ordering easier.

---
Changes since RFCv5:
- Replace "*Kconfig*" by "Kconfig*" + "*/Kconfig*" to avoid matching files like foo-Kconfig, which should not be valid here.
- Same of above for "*Kbuild*" and "*Makefile*"
- Thanks Masahiro Yamada for this suggestion!

Changes since RFCv4:
- Added scripts/* into "build system" section
- Added "git-specific" section with this script and .gitignore
- Thanks for this feedback Nicolas!

Changes since RFCv3:
- Added "*types.h" matching so type headers appear before regular headers
- Removed line ends ($) in patterns: they previously provided a false-positive
- Fixed build patterns to allow matching Kconfig, Kbuild & Makefile in any subdirectory

Changes since RFCv2:
- Fixed licence comment to from /**/ to #
- Fixed filename in how-to comment
- Fix build order: Kconfig -> Kbuild -> Makefile
- Add *.mk extension
- Add line-ends ($) to make sure and get the correct extensions
- Thanks Masahiro Yamada for above suggestions!
- 1 Ack, thanks Randy!

Changes since RFCv1:
- Added Kconfig* (thanks Randy Dunlap!)
- Changed Kbuild to Kbuild* (improve matching)

 scripts/git.orderFile | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +42 -0
new file mode 100644
index 0000000000000..5102ba73357f0
@@ -0,0 +1,42 @@
+# SPDX-License-Identifier: GPL-2.0
+
+# order file for git, to produce patches which are easier to review
+# by diffing the important stuff like header changes first.
+#
+# one-off usage:
+#   git diff -O scripts/git.orderFile ...
+#
+# add to git config:
+#   git config diff.orderFile scripts/git.orderFile
+#
+
+MAINTAINERS
+
+# Documentation
+Documentation/*
+*.rst
+
+# git-specific
+.gitignore
+scripts/git.orderFile
+
+# build system
+Kconfig*
+*/Kconfig*
+Kbuild*
+*/Kbuild*
+Makefile*
+*/Makefile*
+*.mak
+*.mk
+scripts/*
+
+# semantic patches
+*.cocci
+
+# headers
+*types.h
+*.h
+
+# code
+*.c
Signature · 1 line
2.43.0