When passed to git-diff (and to every other git command producing diffs
and/or diffstats) with "-O" or "diff.orderFile", this list of patterns
will place the more declarative / abstract hunks first, while changes to
imperative code / details will be near the end of the patches. This saves
on scrolling / searching and makes for easier reviewing.
We intend to advise contributors in the Wiki to run
git config diff.orderFile scripts/git.orderfile
once, as part of their initial setup, before formatting their first (or,
for repeat contributors, next) patches.
See the "-O" option and the "diff.orderFile" configuration variable in
git-diff(1) and git-config(1).
Cc: "Michael S. Tsirkin" <m...@redhat.com>
Cc: Eric Blake <ebl...@redhat.com>
Cc: Fam Zheng <f...@redhat.com>
Cc: Gerd Hoffmann <kra...@redhat.com>
Cc: John Snow <js...@redhat.com>
Cc: Max Reitz <mre...@redhat.com>
Cc: Stefan Hajnoczi <stefa...@gmail.com>
Signed-off-by: Laszlo Ersek <ler...@redhat.com>
---
Notes:
v2:
- "Makefile" -> "Makefile*" [Gerd]
- add leading comment [Gerd]
- add "docs/*" (note, there are *.txt files outside of docs/, so keeping
those too) [Max, Fam, Eric]
scripts/git.orderfile | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
create mode 100644 scripts/git.orderfile
diff --git a/scripts/git.orderfile b/scripts/git.orderfile
new file mode 100644
index 000000000000..3cab16e0505c
--- /dev/null
+++ b/scripts/git.orderfile
@@ -0,0 +1,20 @@
+# Apply this diff order to your git configuration with the command
+#
+# git config diff.orderFile scripts/git.orderfile
+
+docs/*
+*.txt
+configure
+GNUmakefile
+makefile
+Makefile*
+*.mak
+qapi-schema*.json
+qapi/*.json
+include/qapi/visitor.h
+include/qapi/visitor-impl.h
+scripts/qapi.py
+scripts/*.py
+*.h
+qapi/qapi-visit-core.c
+*.c
--
2.9.2
