linux-kbuild.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [RFC PATCH 1/1] scripts: Introduce a default git.orderFile
@ 2023-09-11 19:37 Leonardo Bras
  2023-09-11 22:05 ` Randy Dunlap
  0 siblings, 1 reply; 3+ messages in thread
From: Leonardo Bras @ 2023-09-11 19:37 UTC (permalink / raw)
  To: Masahiro Yamada, Nathan Chancellor, Nick Desaulniers,
	Nicolas Schier, Mauro Carvalho Chehab
  Cc: Leonardo Bras, linux-kernel, linux-kbuild

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
+
+# semantic patches
+*.cocci
+
+# headers
+*.h
+
+# code
+*.c
-- 
2.42.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [RFC PATCH 1/1] scripts: Introduce a default git.orderFile
  2023-09-11 19:37 [RFC PATCH 1/1] scripts: Introduce a default git.orderFile Leonardo Bras
@ 2023-09-11 22:05 ` Randy Dunlap
  2023-09-11 23:35   ` Leonardo Bras Soares Passos
  0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2023-09-11 22:05 UTC (permalink / raw)
  To: Leonardo Bras, Masahiro Yamada, Nathan Chancellor,
	Nick Desaulniers, Nicolas Schier, Mauro Carvalho Chehab
  Cc: linux-kernel, linux-kbuild



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

-- 
~Randy

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [RFC PATCH 1/1] scripts: Introduce a default git.orderFile
  2023-09-11 22:05 ` Randy Dunlap
@ 2023-09-11 23:35   ` Leonardo Bras Soares Passos
  0 siblings, 0 replies; 3+ messages in thread
From: Leonardo Bras Soares Passos @ 2023-09-11 23:35 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: Masahiro Yamada, Nathan Chancellor, Nick Desaulniers,
	Nicolas Schier, Mauro Carvalho Chehab, linux-kernel,
	linux-kbuild

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
>


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2023-09-12  2:40 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-09-11 19:37 [RFC PATCH 1/1] scripts: Introduce a default git.orderFile Leonardo Bras
2023-09-11 22:05 ` Randy Dunlap
2023-09-11 23:35   ` Leonardo Bras Soares Passos

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).