scripts: Introduce a default git.orderFile
RFC PATCH v4 1/1 scripts: Introduce a default git.orderFile
From: Leonardo Bras <[email protected]>
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 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 | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +34 -0
@@ -0,0 +1,34 @@ +# 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 +*types.h +*.h + +# code +*.c
Signature · 1 line
2.42.0
Quoted 60 lines · Leonardo Bras
From: Leonardo Bras <[email protected]>
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.
Signed-off-by Leonardo Bras <[email protected]>Acked-by Randy Dunlap <[email protected]>---
Please provide feedback on what else to add / remove / reorder here!
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 matchingKconfig,Kbuild&Makefilein any subdirectoryChanges 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!)
- ChangedKbuildto Kbuild* (improve matching)scripts/git.orderFile | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 scripts/git.orderFilescripts/git.orderFile new file +14
-0@@ -0,0 +1,34 @@ +# 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 +
scripts/git.orderFile line 24
Quoted 10 lines
scripts/git.orderFile new file +10
-0+# Documentation +Documentation/* +*.rst + +# build system +*Kconfig* +*Kbuild* +*Makefile* +*.mak +*.mk
I'd like to see 'scripts/*' here, too, to have the build system stuff together. Possibly it makes sense to add .gitignore files here too.
Kind regards,
Nicolas
Quoted 13 lines
scripts/git.orderFile new file +10
-0+ +# semantic patches +*.cocci + +# headers +*types.h +*.h + +# code +*.cSignature · 1 line
2.42.0
Quoted 76 lines · Nicolas Schier
Quoted 60 lines · Leonardo Bras
From: Leonardo Bras <[email protected]>
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.
Signed-off-by Leonardo Bras <[email protected]>Acked-by Randy Dunlap <[email protected]>---
Please provide feedback on what else to add / remove / reorder here!
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 matchingKconfig,Kbuild&Makefilein any subdirectoryChanges 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!)
- ChangedKbuildto Kbuild* (improve matching)scripts/git.orderFile | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 scripts/git.orderFilescripts/git.orderFile new file +14
-0@@ -0,0 +1,34 @@ +# 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 +scripts/git.orderFile line 24
Quoted 10 lines
scripts/git.orderFile new file +10
-0+# Documentation +Documentation/* +*.rst + +# build system +*Kconfig* +*Kbuild* +*Makefile* +*.mak +*.mkI'd like to see '
scripts/*' here, too, to have the build system stuff together. Possibly it makes sense to add .gitignore files here too.
Quoted 2 lines
Kind regards,
Nicolas
Sure, I will add it and send a v5 soon.
Thanks!
Quoted 16 lines
Quoted 15 lines
scripts/git.orderFile new file +10
-1+ +# semantic patches +*.cocci + +# headers +*types.h +*.h + +# code +*.c --2.42.0