| Message ID | 20230911193752.27642-2-leobras@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [RFC,1/1] scripts: Introduce a default git.orderFile | expand |
On 9/11/23 12:37, Leonardo Bras 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@redhat.com> > --- > > 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 > > diff --git a/scripts/git.orderFile b/scripts/git.orderFile > new file mode 100644 > index 000000000000..3434028be2f2 > --- /dev/null > +++ b/scripts/git.orderFile > @@ -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 Can we have Kconfig* here also? thanks. > + > +# semantic patches > +*.cocci > + > +# headers > +*.h > + > +# code > +*.c
On Mon, Sep 11, 2023 at 7:58 PM Randy Dunlap <rdunlap@infradead.org> wrote: > > > > On 9/11/23 12:37, Leonardo Bras 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@redhat.com> > > --- > > > > 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 > > > > diff --git a/scripts/git.orderFile b/scripts/git.orderFile > > new file mode 100644 > > index 000000000000..3434028be2f2 > > --- /dev/null > > +++ b/scripts/git.orderFile > > @@ -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 > > Can we have Kconfig* here also? Sure! Thanks for reviewing! > thanks. > > > + > > +# semantic patches > > +*.cocci > > + > > +# headers > > +*.h > > + > > +# code > > +*.c > > -- > ~Randy >
diff --git a/scripts/git.orderFile b/scripts/git.orderFile new file mode 100644 index 000000000000..3434028be2f2 --- /dev/null +++ b/scripts/git.orderFile @@ -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
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@redhat.com> --- 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