Re: [RFC PATCH v2 1/1] scripts: Introduce a default git.orderFile

From: Randy Dunlap
Date: Tue Sep 12 2023 - 00:24:24 EST




On 9/11/23 16:44, 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@xxxxxxxxxx>

LGTM. Thanks.

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

> ---
>
> Please provide feedback on what else to add / remove / reorder here!
>
> Changes since RFCv1:
> - Added Kconfig* (thanks Randy Dunlap!)
> - Changed Kbuild to Kbuild* (improve matching)
>
> scripts/git.orderFile | 32 ++++++++++++++++++++++++++++++++
> 1 file changed, 32 insertions(+)
> create mode 100644 scripts/git.orderFile
>
> diff --git a/scripts/git.orderFile b/scripts/git.orderFile
> new file mode 100644
> index 000000000000..819f0a957fe3
> --- /dev/null
> +++ b/scripts/git.orderFile
> @@ -0,0 +1,32 @@
> +/* 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*
> +Kconfig*
> +Makefile*
> +*.mak
> +
> +# semantic patches
> +*.cocci
> +
> +# headers
> +*.h
> +
> +# code
> +*.c

--
~Randy