Skip to contentSkip to conversation

scripts: Introduce a default git.orderFile

RFC PATCH Superseded Leonardo Bras 4 participants 13 messages Dec 8, 2023 – Dec 15, 2023 Kbuild

v5 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

RFC PATCH v5 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 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 | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +39 -0
new file mode 100644
index 0000000000000..31649ff53d22c
@@ -0,0 +1,39 @@
+# 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*
+*Kbuild*
+*Makefile*
+*.mak
+*.mk
+scripts/*
+
+# semantic patches
+*.cocci
+
+# headers
+*types.h
+*.h
+
+# code
+*.c
Signature · 1 line
2.43.0
#1 lore raw
Quoted 59 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.

---
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 | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +11 -0
new file mode 100644
index 0000000000000..31649ff53d22c
@@ -0,0 +1,39 @@
+# 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 21

Quoted 10 lines
scripts/git.orderFile new file +10 -0
+
+MAINTAINERS
+
+# Documentation
+Documentation/*
+*.rst
+
+# git-specific
+.gitignore
+scripts/git.orderFile

I think scripts/git.orderFile should be part of
"scripts/*" below.

scripts/git.orderFile line 26

Quoted 5 lines
scripts/git.orderFile new file +5 -0
+
+# build system
+*Kconfig*
+*Kbuild*
+*Makefile*

I do not like this because "foo-Makefile-bar"
is not a Makefile, but would match "*Makefile*".

If you do not use wildcard at all, 'Makefile'
will match to the root-dir and sub-directories.

Kconfig
*/Kconfig*
Kbuild
Makefile
*.mak
*.mk
scripts/*

may satisfy your needs mostly.

Quoted 16 lines
scripts/git.orderFile new file +13 -1
+*.mak
+*.mk
+scripts/*
+
+# semantic patches
+*.cocci
+
+# headers
+*types.h
+*.h
+
+# code
+*.c
--

2.43.0

Signature · 2 lines
Best Regards
Masahiro Yamada
#2 lore raw

From: Leonardo Bras <[email protected]>

Quoted 62 lines · Masahiro Yamada
Quoted 61 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.

---
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 | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +13 -0
new file mode 100644
index 0000000000000..31649ff53d22c
@@ -0,0 +1,39 @@
+# 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
Quoted 9 lines

scripts/git.orderFile line 21

Quoted 8 lines
scripts/git.orderFile new file +8 -0
+
+# Documentation
+Documentation/*
+*.rst
+
+# git-specific
+.gitignore
+scripts/git.orderFile

Hello Masahiro, thanks for the feedback!

Quoted 10 lines

I think scripts/git.orderFile should be part of
"scripts/*" below.

Quoted 8 lines

scripts/git.orderFile line 26

Quoted 5 lines
scripts/git.orderFile new file +5 -0
+
+# build system
+*Kconfig*
+*Kbuild*
+*Makefile*

I do not like this because "foo-Makefile-bar"
is not a Makefile, but would match "*Makefile*".

That makes sense.

Quoted 4 lines

If you do not use wildcard at all, 'Makefile'
will match to the root-dir and sub-directories.

I tried a quick test here changing an mm/*.c file and mm/Makefile, and the above will print the .c file changes first in any situation here, so it won't have the desired behavior.

But if we want to achieve the above we can do so with a slight change in the suggestion:

Quoted 6 lines

Kconfig
*/Kconfig*
Kbuild
Makefile

*/Makefile

Quoted 7 lines

*.mak
*.mk
scripts/*

may satisfy your needs mostly.

I have tried the following in the Kernel root:

$ find . |grep Makefile |grep -v Makefile$
./arch/arm/mach-s3c/Makefile.s3c64xx
./arch/mips/Makefile.postlink
./arch/powerpc/Makefile.postlink
./arch/um/Makefile-os-Linux
./arch/um/Makefile-skas
./arch/um/scripts/Makefile.rules
./arch/x86/Makefile_32.cpu
./arch/x86/Makefile.um
./arch/x86/Makefile.postlink
./arch/riscv/Makefile.postlink
./drivers/firmware/efi/libstub/Makefile.zboot
./drivers/usb/serial/Makefile-keyspan_pda_fw
[...]
$ find . |grep Kbuild |grep -v Kbuild$
./arch/mips/Kbuild.platforms
./scripts/Kbuild.include

Which leads to an honest question:
Don't we want to show changes on those files before C files, for example?

If so, we need something like:

# build system
Kconfig*
*/Kconfig*
Kbuild*
*/Kbuild*
Makefile*
*/Makefile*
*.mak
*.mk
scripts/*

It would get rid of "foo-Makefile-bar" case but still match "Makefile-bar" case, which seems to be used around.

Is that ok?

Thanks!
Leo

#4 lore raw
In reply to [email protected]
Quoted 101 lines · On Mon, Dec 11, 2023 at 10:14 PM <[email protected]> wrote:

From: Leonardo Bras <[email protected]>

Quoted 62 lines · Masahiro Yamada
Quoted 61 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.

---
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 | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +13 -0
new file mode 100644
index 0000000000000..31649ff53d22c
@@ -0,0 +1,39 @@
+# 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
Quoted 9 lines

scripts/git.orderFile line 21

Quoted 8 lines
scripts/git.orderFile new file +8 -0
+
+# Documentation
+Documentation/*
+*.rst
+
+# git-specific
+.gitignore
+scripts/git.orderFile

Hello Masahiro, thanks for the feedback!

Quoted 10 lines

I think scripts/git.orderFile should be part of
"scripts/*" below.

Quoted 8 lines

scripts/git.orderFile line 26

Quoted 5 lines
scripts/git.orderFile new file +5 -0
+
+# build system
+*Kconfig*
+*Kbuild*
+*Makefile*

I do not like this because "foo-Makefile-bar"
is not a Makefile, but would match "*Makefile*".

That makes sense.

Quoted 2 lines
Quoted 6 lines
Quoted 2 lines

If you do not use wildcard at all, 'Makefile'
will match to the root-dir and sub-directories.

I tried a quick test here changing an mm/*.c file and mm/Makefile, and the above will print the .c file changes first in any situation here, so it won't have the desired behavior.

Hmm, you are right.

OK, your suggestion below looks good.

Thanks.

Quoted 65 lines

But if we want to achieve the above we can do so with a slight change in the suggestion:

Quoted 6 lines

Kconfig
*/Kconfig*
Kbuild
Makefile

*/Makefile

Quoted 7 lines

*.mak
*.mk
scripts/*

may satisfy your needs mostly.

I have tried the following in the Kernel root:

$ find . |grep Makefile |grep -v Makefile$
./arch/arm/mach-s3c/Makefile.s3c64xx
./arch/mips/Makefile.postlink
./arch/powerpc/Makefile.postlink
./arch/um/Makefile-os-Linux
./arch/um/Makefile-skas
./arch/um/scripts/Makefile.rules
./arch/x86/Makefile_32.cpu
./arch/x86/Makefile.um
./arch/x86/Makefile.postlink
./arch/riscv/Makefile.postlink
./drivers/firmware/efi/libstub/Makefile.zboot
./drivers/usb/serial/Makefile-keyspan_pda_fw
[...]
$ find . |grep Kbuild |grep -v Kbuild$
./arch/mips/Kbuild.platforms
./scripts/Kbuild.include

Which leads to an honest question:
Don't we want to show changes on those files before C files, for example?

If so, we need something like:

# build system
Kconfig*
*/Kconfig*
Kbuild*
*/Kbuild*
Makefile*
*/Makefile*
*.mak
*.mk
scripts/*

It would get rid of "foo-Makefile-bar" case but still match "Makefile-bar" case, which seems to be used around.

Is that ok?

Thanks!
Leo

Signature · 2 lines
Best Regards
Masahiro Yamada
#5 lore raw

From: Leonardo Bras <[email protected]>

Quoted 111 lines · Masahiro Yamada
Quoted 101 lines · On Mon, Dec 11, 2023 at 10:14 PM <[email protected]> wrote:

From: Leonardo Bras <[email protected]>

Quoted 62 lines · Masahiro Yamada
Quoted 61 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.

---
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 | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +13 -0
new file mode 100644
index 0000000000000..31649ff53d22c
@@ -0,0 +1,39 @@
+# 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
Quoted 9 lines

scripts/git.orderFile line 21

Quoted 8 lines
scripts/git.orderFile new file +8 -0
+
+# Documentation
+Documentation/*
+*.rst
+
+# git-specific
+.gitignore
+scripts/git.orderFile

Hello Masahiro, thanks for the feedback!

Quoted 10 lines

I think scripts/git.orderFile should be part of
"scripts/*" below.

Quoted 8 lines

scripts/git.orderFile line 26

Quoted 5 lines
scripts/git.orderFile new file +5 -0
+
+# build system
+*Kconfig*
+*Kbuild*
+*Makefile*

I do not like this because "foo-Makefile-bar"
is not a Makefile, but would match "*Makefile*".

That makes sense.

Quoted 2 lines
Quoted 6 lines
Quoted 2 lines

If you do not use wildcard at all, 'Makefile'
will match to the root-dir and sub-directories.

I tried a quick test here changing an mm/*.c file and mm/Makefile, and the above will print the .c file changes first in any situation here, so it won't have the desired behavior.

Quoted 7 lines

Hmm, you are right.

OK, your suggestion below looks good.

Thanks.

Thank you for this feedback!

I will send a v6 shortly.

Thank you!
Leo

Quoted 77 lines
Quoted 71 lines

But if we want to achieve the above we can do so with a slight change in the suggestion:

Quoted 6 lines

Kconfig
*/Kconfig*
Kbuild
Makefile

*/Makefile

Quoted 7 lines

*.mak
*.mk
scripts/*

may satisfy your needs mostly.

I have tried the following in the Kernel root:

$ find . |grep Makefile |grep -v Makefile$
./arch/arm/mach-s3c/Makefile.s3c64xx
./arch/mips/Makefile.postlink
./arch/powerpc/Makefile.postlink
./arch/um/Makefile-os-Linux
./arch/um/Makefile-skas
./arch/um/scripts/Makefile.rules
./arch/x86/Makefile_32.cpu
./arch/x86/Makefile.um
./arch/x86/Makefile.postlink
./arch/riscv/Makefile.postlink
./drivers/firmware/efi/libstub/Makefile.zboot
./drivers/usb/serial/Makefile-keyspan_pda_fw
[...]
$ find . |grep Kbuild |grep -v Kbuild$
./arch/mips/Kbuild.platforms
./scripts/Kbuild.include

Which leads to an honest question:
Don't we want to show changes on those files before C files, for example?

If so, we need something like:

# build system
Kconfig*
*/Kconfig*
Kbuild*
*/Kbuild*
Makefile*
*/Makefile*
*.mak
*.mk
scripts/*

It would get rid of "foo-Makefile-bar" case but still match "Makefile-bar" case, which seems to be used around.

Is that ok?

Thanks!
Leo

Signature · 2 lines
Best Regards
Masahiro Yamada
#6 lore raw

From: Leonardo Bras <[email protected]>

Quoted 120 lines · On Mon, Dec 11, 2023 at 07:03:50PM -0300, [email protected] wrote:

From: Leonardo Bras <[email protected]>

Quoted 117 lines · Masahiro Yamada
Quoted 101 lines · On Mon, Dec 11, 2023 at 10:14 PM <[email protected]> wrote:

From: Leonardo Bras <[email protected]>

Quoted 62 lines · Masahiro Yamada
Quoted 61 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.

---
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 | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 scripts/git.orderFile
scripts/git.orderFile new file +13 -0
new file mode 100644
index 0000000000000..31649ff53d22c
@@ -0,0 +1,39 @@
+# 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
Quoted 9 lines

scripts/git.orderFile line 21

Quoted 8 lines
scripts/git.orderFile new file +8 -0
+
+# Documentation
+Documentation/*
+*.rst
+
+# git-specific
+.gitignore
+scripts/git.orderFile

Hello Masahiro, thanks for the feedback!

Quoted 10 lines

I think scripts/git.orderFile should be part of
"scripts/*" below.

Quoted 8 lines

scripts/git.orderFile line 26

Quoted 5 lines
scripts/git.orderFile new file +5 -0
+
+# build system
+*Kconfig*
+*Kbuild*
+*Makefile*

I do not like this because "foo-Makefile-bar"
is not a Makefile, but would match "*Makefile*".

That makes sense.

Quoted 2 lines
Quoted 6 lines
Quoted 2 lines

If you do not use wildcard at all, 'Makefile'
will match to the root-dir and sub-directories.

I tried a quick test here changing an mm/*.c file and mm/Makefile, and the above will print the .c file changes first in any situation here, so it won't have the desired behavior.

Hmm, you are right.

OK, your suggestion below looks good.

Quoted 86 lines
Quoted 1 line

Thanks.

Thank you for this feedback!

I will send a v6 shortly.

Thank you!
Leo

Quoted 77 lines
Quoted 71 lines

But if we want to achieve the above we can do so with a slight change in the suggestion:

Quoted 6 lines

Kconfig
*/Kconfig*
Kbuild
Makefile

*/Makefile

Quoted 7 lines

*.mak
*.mk
scripts/*

may satisfy your needs mostly.

I have tried the following in the Kernel root:

$ find . |grep Makefile |grep -v Makefile$
./arch/arm/mach-s3c/Makefile.s3c64xx
./arch/mips/Makefile.postlink
./arch/powerpc/Makefile.postlink
./arch/um/Makefile-os-Linux
./arch/um/Makefile-skas
./arch/um/scripts/Makefile.rules
./arch/x86/Makefile_32.cpu
./arch/x86/Makefile.um
./arch/x86/Makefile.postlink
./arch/riscv/Makefile.postlink
./drivers/firmware/efi/libstub/Makefile.zboot
./drivers/usb/serial/Makefile-keyspan_pda_fw
[...]
$ find . |grep Kbuild |grep -v Kbuild$
./arch/mips/Kbuild.platforms
./scripts/Kbuild.include

Which leads to an honest question:
Don't we want to show changes on those files before C files, for example?

If so, we need something like:

# build system
Kconfig*
*/Kconfig*
Kbuild*
*/Kbuild*
Makefile*
*/Makefile*
*.mak
*.mk
scripts/*

It would get rid of "foo-Makefile-bar" case but still match "Makefile-bar" case, which seems to be used around.

Is that ok?

Thanks!
Leo

Signature · 2 lines
Best Regards
Masahiro Yamada

RFCv6 patch at:
https://lore.kernel.org/all/[email protected]/

#7 lore raw
In reply to Leonardo Bras

Urrg, hell no. Alphabetic order is the only one allowing sensible searching. If you have a different preference use your local .gitconfig instead of enforcing completely random preference on others.

#8 lore raw
Quoted 4 lines · Christoph Hellwig

Urrg, hell no. Alphabetic order is the only one allowing sensible searching. If you have a different preference use your local .gitconfig instead of enforcing completely random preference on others.

Unlike .gitignore, this feature is opt-in rather than enforced.

To use this, you need to run

'git config diff.orderFile scripts/git.orderFile'

or

'git diff -C scripts/git.orderFile'

Indeed, the file order is subjective, leaving
us a question "do we need it in upstream"?

At least, it is harmless for people who have no interest.

--
Best Regards
Masahiro Yamada

#9 lore raw
Quoted 9 lines · Masahiro Yamada

Unlike .gitignore, this feature is opt-in rather than enforced.

To use this, you need to run

'git config diff.orderFile scripts/git.orderFile'

or

'git diff -C scripts/git.orderFile'

Oh, ok. That greatly reduces my concern.

Quoted 5 lines

Indeed, the file order is subjective, leaving
us a question "do we need it in upstream"?

At least, it is harmless for people who have no interest.

.. but this is still a good question. I'm not really sure there is much of a need for it, but as long as it doesn't harm everyone else I'm at least neutral on it.

#10 lore raw
Quoted 5 lines · Christoph Hellwig
Quoted 4 lines · Masahiro Yamada

Unlike .gitignore, this feature is opt-in rather than enforced.

To use this, you need to run

Quoted 7 lines
Quoted 5 lines

'git config diff.orderFile scripts/git.orderFile'

or

'git diff -C scripts/git.orderFile'

Oh, ok. That greatly reduces my concern.

Yes, it's an opt-in, so no user should be directly impacted.

Quoted 4 lines
Quoted 4 lines

Indeed, the file order is subjective, leaving
us a question "do we need it in upstream"?

The main idea is patch generation.
This file's order is supposed to be the best order for reading a raw patch and understanding the code changes.

Quoted 6 lines
Quoted 2 lines

At least, it is harmless for people who have no interest.

.. but this is still a good question. I'm not really sure there is much of a need for it, but as long as it doesn't harm everyone else I'm at least neutral on it.

diff.orderfile was introduced in git to help order the git diff, and thus the patch generation, in a way that it's easier to understand what the commit / patch intends on doing.

Take this example introducing a feature foo, you should see:
- Documentation on foo, if introduced
- How is foo enabled in build system, if needed
- The types / stucts / fields introduced by foo, if any
- The interface for using foo, if any
- The actual foo implementation.

Of course the actual order is open to discussion, and I encourage everyone to suggest any other items or order.

Thanks!
Leo

#11 lore raw
Quoted 9 lines · Leonardo Bras
Quoted 7 lines · Christoph Hellwig
Quoted 6 lines · Masahiro Yamada

Unlike .gitignore, this feature is opt-in rather than enforced.

To use this, you need to run

'git config diff.orderFile scripts/git.orderFile'

Quoted 7 lines
Quoted 5 lines
Quoted 3 lines

or

'git diff -C scripts/git.orderFile'

Oh, ok. That greatly reduces my concern.

Yes, it's an opt-in, so no user should be directly impacted.

Applied to linux-kbuild.
Thanks.

Quoted 34 lines
Quoted 4 lines
Quoted 4 lines

Indeed, the file order is subjective, leaving
us a question "do we need it in upstream"?

The main idea is patch generation.
This file's order is supposed to be the best order for reading a raw patch and understanding the code changes.

Quoted 6 lines
Quoted 2 lines

At least, it is harmless for people who have no interest.

.. but this is still a good question. I'm not really sure there is much of a need for it, but as long as it doesn't harm everyone else I'm at least neutral on it.

diff.orderfile was introduced in git to help order the git diff, and thus the patch generation, in a way that it's easier to understand what the commit / patch intends on doing.

Take this example introducing a feature foo, you should see:
- Documentation on foo, if introduced
- How is foo enabled in build system, if needed
- The types / stucts / fields introduced by foo, if any
- The interface for using foo, if any
- The actual foo implementation.

Of course the actual order is open to discussion, and I encourage everyone to suggest any other items or order.

Thanks!
Leo

Signature · 2 lines
Best Regards
Masahiro Yamada
#12 lore raw
Quoted 15 lines · Masahiro Yamada
Quoted 13 lines · Leonardo Bras
Quoted 11 lines · Christoph Hellwig
Quoted 9 lines · Masahiro Yamada

Unlike .gitignore, this feature is opt-in rather than enforced.

To use this, you need to run

'git config diff.orderFile scripts/git.orderFile'

or

'git diff -C scripts/git.orderFile'

Quoted 7 lines
Quoted 3 lines
Quoted 1 line

Oh, ok. That greatly reduces my concern.

Yes, it's an opt-in, so no user should be directly impacted.

Applied to linux-kbuild.
Thanks.

Thank you!

Quoted 46 lines
Quoted 33 lines
Quoted 10 lines
Quoted 10 lines

Indeed, the file order is subjective, leaving
us a question "do we need it in upstream"?

The main idea is patch generation.
This file's order is supposed to be the best order for reading a raw patch and understanding the code changes.

Quoted 6 lines
Quoted 2 lines

At least, it is harmless for people who have no interest.

.. but this is still a good question. I'm not really sure there is much of a need for it, but as long as it doesn't harm everyone else I'm at least neutral on it.

diff.orderfile was introduced in git to help order the git diff, and thus the patch generation, in a way that it's easier to understand what the commit / patch intends on doing.

Take this example introducing a feature foo, you should see:
- Documentation on foo, if introduced
- How is foo enabled in build system, if needed
- The types / stucts / fields introduced by foo, if any
- The interface for using foo, if any
- The actual foo implementation.

Quoted 7 lines

Of course the actual order is open to discussion, and I encourage everyone to suggest any other items or order.

Thanks!
Leo

--
Best Regards
Masahiro Yamada