Skip to contentSkip to conversation

scripts: Introduce a default git.orderFile

RFC PATCH Superseded Leonardo Bras 1 participant 1 message Sep 12, 2023

v3 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

RFC PATCH v3 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.

---

Please provide feedback on what else to add / remove / reorder here!

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 | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +33 -0
new file mode 100644
index 000000000000..fe985046613f
@@ -0,0 +1,33 @@
+# 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$
+
+# build system
+Kconfig*
+Kbuild*
+Makefile*
+*.mak$
+*.mk$
+
+# semantic patches
+*.cocci$
+
+# headers
+*.h$
+
+# code
+*.c$
Signature · 1 line
2.42.0