Re: [PATCH 1/1] BaseTools: convert diff.order to LF-only

["Michael D Kinney" <michael.d.kinney@intel.com>]

Leif,

PatchCheck.py should only check added lines, not removed lines.

Are you seeing an error on a removed line?

Mike

> -----Original Message-----
> From: Leif Lindholm <leif@nuviainc.com>
> Sent: Wednesday, April 22, 2020 8:47 AM
> To: devel@edk2.groups.io
> Cc: Andrew Fish <afish@apple.com>; Laszlo Ersek
> <lersek@redhat.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>; Feng, Bob C
> <bob.c.feng@intel.com>; Gao, Liming
> <liming.gao@intel.com>
> Subject: [PATCH 1/1] BaseTools: convert diff.order to
> LF-only
> 
> SetupGit.py sets the git config option diff.orderFile
> to
> {edk2 directory}/BaseTools/Conf/diff.order, to override
> the default order
> in which files are shown in a diff/patch/whatever. This
> is in imitation
> of what is done manually in Laszlo's Unkempt Guide.
> 
> However, the version currently in the tree is in CRLF
> format, which makes
> git interpret e.g. *.c as matching on *.c<CR>, finding
> no matches and
> failing to apply the desired reordering. Note: this is
> true regardless of
> whether running on Linux or Windows.
> 
> Convert the file to LF-only to make it work as
> expected.
> 
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Signed-off-by: Leif Lindholm <leif@nuviainc.com>
> ---
> 
> I'm not going to reveal just how much time I wasted on
> this before I
> figured out what was going wrong...
> 
> I am intending to start prototyping the overall CRLF-
> >native
> conversion shortly, but this needs resolving
> regardless, and in fact we
> will need to override the line ending conversion for
> this file in
> gitattributes.
> 
> Arguably, the same logic could be applied to the
> gitattributes file
> itself (in the same directory), but since every
> effective line in that
> has an explicit option following the glob, it triggers
> no issues at
> present.
> 
> This bug is quite likely also behind some accusations
> I've made on
> people not following the correct patch submission
> process, for which I
> apologise.
> 
> Finally, a question: did we have some way of overriding
> the PatchCheck.py
> step in mergify? This patch gets an error per line...
> If not, should I submit a separate patch adding yet
> another exception to
> PatchCheck.py?
> 
> /
>     Leif
> 
>  BaseTools/Conf/diff.order | 26 +++++++++++++----------
> ---
>  1 file changed, 13 insertions(+), 13 deletions(-)
> 
> diff --git a/BaseTools/Conf/diff.order
> b/BaseTools/Conf/diff.order
> index 4361817012c9..f1534f6c187c 100644
> --- a/BaseTools/Conf/diff.order
> +++ b/BaseTools/Conf/diff.order
> @@ -1,13 +1,13 @@
> -#
> -# Copyright (c) 2019, Linaro Ltd. All rights reserved.
> -#
> -# SPDX-License-Identifier: BSD-2-Clause-Patent
> -#
> -*.dec
> -*.dsc.inc
> -*.dsc
> -*.fdf
> -*.inf
> -*.h
> -*.vfr
> -*.c
> +#
> +# Copyright (c) 2019, Linaro Ltd. All rights reserved.
> +#
> +# SPDX-License-Identifier: BSD-2-Clause-Patent
> +#
> +*.dec
> +*.dsc.inc
> +*.dsc
> +*.fdf
> +*.inf
> +*.h
> +*.vfr
> +*.c
> --
> 2.20.1