Skip to contentSkip to conversation

scripts: Introduce a default git.orderFile

RFC PATCH Superseded Leonardo Bras 2 participants 3 messages Sep 11, 2023 – Sep 12, 2023 Kbuild

v1 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

RFC PATCH 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!

 scripts/git.orderFile | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +31 -0
new file mode 100644
index 000000000000..3434028be2f2
@@ -0,0 +1,31 @@
+/* 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
+Kbuild
+Makefile*
+*.mak
+
+# semantic patches
+*.cocci
+
+# headers
+*.h
+
+# code
+*.c
Signature · 1 line
2.42.0
#1 lore raw
Quoted 34 lines · Leonardo Bras

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!

 scripts/git.orderFile | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +12 -0
new file mode 100644
index 000000000000..3434028be2f2
@@ -0,0 +1,31 @@
+/* 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
+#
+

scripts/git.orderFile line 22

Quoted 10 lines
scripts/git.orderFile new file +10 -0
+MAINTAINERS
+
+# Documentation
+Documentation/*
+*.rst
+
+# build system
+Kbuild
+Makefile*
+*.mak

Can we have Kconfig* here also?
thanks.

Quoted 9 lines
scripts/git.orderFile new file +9 -0
+
+# semantic patches
+*.cocci
+
+# headers
+*.h
+
+# code
+*.c
Signature · 1 line
~Randy
#2 lore raw
Quoted 42 lines · Randy Dunlap
Quoted 38 lines · Leonardo Bras

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!

 scripts/git.orderFile | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +16 -0
new file mode 100644
index 000000000000..3434028be2f2
@@ -0,0 +1,31 @@
+/* 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/*
Quoted 8 lines

scripts/git.orderFile line 22

Quoted 6 lines
scripts/git.orderFile new file +6 -0
+*.rst
+
+# build system
+Kbuild
+Makefile*
+*.mak

Can we have Kconfig* here also?

Sure!

Thanks for reviewing!

Quoted 15 lines

thanks.

scripts/git.orderFile line 31

Quoted 9 lines
scripts/git.orderFile new file +9 -0
+
+# semantic patches
+*.cocci
+
+# headers
+*.h
+
+# code
+*.c

--
~Randy