[PATCH 1/1] BaseTools/Scripts/PatchCheck.py: Check for *.makefile

[PATCH 1/1] BaseTools/Scripts/PatchCheck.py: Check for *.makefile

[Rebecca Cran]

When checking for Makefiles, in addition to Makefile and GNUmakefile,
also check for *.makefile: this allows {header,footer,app,lib}.makefile
in BaseTools/Source/C/Makefiles to be detected and avoid having
PatchCheck.py complain about tab characters.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
---
 BaseTools/Scripts/PatchCheck.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/BaseTools/Scripts/PatchCheck.py b/BaseTools/Scripts/PatchCheck.py
index fcdabfc8acea..3910015d173e 100755
--- a/BaseTools/Scripts/PatchCheck.py
+++ b/BaseTools/Scripts/PatchCheck.py
@@ -383,7 +383,8 @@ class GitDiffCheck:
                     self.force_crlf = False
                     self.force_notabs = False
                 if os.path.basename(self.filename) == 'GNUmakefile' or \
-                   os.path.basename(self.filename) == 'Makefile':
+                   os.path.basename(self.filename) == 'Makefile' or \
+                   os.path.basename(self.filename).endswith("makefile"):
                     self.force_notabs = False
             elif len(line.rstrip()) != 0:
                 self.format_error("didn't find diff command")
-- 
2.34.1

Re: [PATCH 1/1] BaseTools/Scripts/PatchCheck.py: Check for *.makefile

[Michael D Kinney]

> -----Original Message-----
> From: Rebecca Cran <rebecca@bsdio.com>
> Sent: Friday, March 24, 2023 9:32 AM
> To: devel@edk2.groups.io; Feng, Bob C <bob.c.feng@intel.com>; Gao, Liming <gaoliming@byosoft.com.cn>; Chen, Christine
> <yuwei.chen@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Subject: [PATCH 1/1] BaseTools/Scripts/PatchCheck.py: Check for *.makefile
> 
> When checking for Makefiles, in addition to Makefile and GNUmakefile,
> also check for *.makefile: this allows {header,footer,app,lib}.makefile
> in BaseTools/Source/C/Makefiles to be detected and avoid having
> PatchCheck.py complain about tab characters.
> 
> Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
> ---
>  BaseTools/Scripts/PatchCheck.py | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/BaseTools/Scripts/PatchCheck.py b/BaseTools/Scripts/PatchCheck.py
> index fcdabfc8acea..3910015d173e 100755
> --- a/BaseTools/Scripts/PatchCheck.py
> +++ b/BaseTools/Scripts/PatchCheck.py
> @@ -383,7 +383,8 @@ class GitDiffCheck:
>                      self.force_crlf = False
>                      self.force_notabs = False
>                  if os.path.basename(self.filename) == 'GNUmakefile' or \
> -                   os.path.basename(self.filename) == 'Makefile':
> +                   os.path.basename(self.filename) == 'Makefile' or \
> +                   os.path.basename(self.filename).endswith("makefile"):

Should is be ".makefile" or perhaps use os.path.splitext() instead?

>                      self.force_notabs = False
>              elif len(line.rstrip()) != 0:
>                  self.format_error("didn't find diff command")
> --
> 2.34.1

Re: [PATCH 1/1] BaseTools/Scripts/PatchCheck.py: Check for *.makefile

[Rebecca Cran]

On 3/24/23 12:46 PM, Kinney, Michael D wrote:
> Should is be ".makefile" or perhaps use os.path.splitext() instead?

Good point. I've updated the code to use os.path.splitext() instead, and 
change the check for 'Makefile' to be case-insensitive since some are 
which are missing the upper-case 'M':


./BaseTools/Source/C/VfrCompile/Pccts/support/genmk/makefile
./BaseTools/Source/C/VfrCompile/Pccts/support/rexpr/makefile
./BaseTools/Source/C/VfrCompile/Pccts/antlr/makefile
./BaseTools/Source/C/VfrCompile/Pccts/dlg/makefile


I've sent out a v2 revision.


-- 
Rebecca Cran