From: Leonardo Bras <leobras@xxxxxxxxxx> On Tue, Dec 12, 2023 at 03:05:38AM +0900, Masahiro Yamada wrote: > On Mon, Dec 11, 2023 at 10:14 PM <lsoaresp@xxxxxxxxxx> wrote: > > > > From: Leonardo Bras <masahiroy@xxxxxxxxxx> > > > > On Sun, Dec 10, 2023 at 04:13:54AM +0900, Masahiro Yamada wrote: > > > On Sat, Dec 9, 2023 at 3:19 AM Leonardo Bras <leobras@xxxxxxxxxx> wrote: > > > > > > > > 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 <leobras@xxxxxxxxxx> > > > > Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> > > > > > > > > --- > > > > 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 > > > > > > > > diff --git a/scripts/git.orderFile b/scripts/git.orderFile > > > > new file mode 100644 > > > > index 0000000000000..31649ff53d22c > > > > --- /dev/null > > > > +++ b/scripts/git.orderFile > > > > @@ -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 > > > > > > > Hello Masahiro, thanks for the feedback! > > > > > > > > > > > I think scripts/git.orderFile should be part of > > > "scripts/*" below. > > > > > > > > > > > > > > > > > > > > > > + > > > > +# 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. > > > > > > > > > > > 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. Thank you for this feedback! I will send a v6 shortly. Thank you! Leo > > > > > > > > > > But if we want to achieve the above we can do so with a slight change in > > the suggestion: > > > > > > >> > > > Kconfig > > > */Kconfig* > > > Kbuild > > > Makefile > > */Makefile > > > *.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 > > > > > > > -- > Best Regards > Masahiro Yamada >
