BaseTools/Scripts/PatchCheck.py: Remove submodule false positives master
authorMichael D Kinney <michael.d.kinney@intel.com>
Thu, 23 Jan 2020 23:07:42 +0000 (15:07 -0800)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Fri, 24 Jan 2020 18:30:13 +0000 (18:30 +0000)
https://bugzilla.tianocore.org/show_bug.cgi?id=2484
https://bugzilla.tianocore.org/show_bug.cgi?id=2485

Update PatchCheck to not enforce no tabs and not enforce CR/LF
line endings for .gitmodules files.  These files are updated by
git when a git submodule command is used and the updates by git
use tab characters and LF line endings.

Also update patch check to not enforce CR/LF line endings for
patch lines that create a submodule directory.  These patch
lines use LF line endings.  The git submodule directory is
added as a new file with attributes 160000 that can be detected
by looking for the pattern "new file mode 160000".

Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
BaseTools/Scripts/PatchCheck.py

index 173d451..6823cc6 100755 (executable)
@@ -341,7 +341,21 @@ class GitDiffCheck:
                 self.state = PRE_PATCH\r
                 self.filename = line[13:].split(' ', 1)[0]\r
                 self.is_newfile = False\r
-                self.force_crlf = not self.filename.endswith('.sh')\r
+                self.force_crlf = True\r
+                self.force_notabs = True\r
+                if self.filename.endswith('.sh'):\r
+                    #\r
+                    # Do not enforce CR/LF line endings for linux shell scripts.\r
+                    #\r
+                    self.force_crlf = False\r
+                if self.filename == '.gitmodules':\r
+                    #\r
+                    # .gitmodules is updated by git and uses tabs and LF line\r
+                    # endings.  Do not enforce no tabs and do not enforce\r
+                    # CR/LF line endings.\r
+                    #\r
+                    self.force_crlf = False\r
+                    self.force_notabs = False\r
             elif len(line.rstrip()) != 0:\r
                 self.format_error("didn't find diff command")\r
             self.line_num += 1\r
@@ -355,6 +369,11 @@ class GitDiffCheck:
                 self.binary = True\r
                 if self.is_newfile:\r
                     self.new_bin.append(self.filename)\r
+            elif line.startswith('new file mode 160000'):\r
+                #\r
+                # New submodule.  Do not enforce CR/LF line endings\r
+                #\r
+                self.force_crlf = False\r
             else:\r
                 ok = False\r
                 self.is_newfile = self.newfile_prefix_re.match(line)\r
@@ -429,7 +448,7 @@ class GitDiffCheck:
         if self.force_crlf and eol != '\r\n':\r
             self.added_line_error('Line ending (%s) is not CRLF' % repr(eol),\r
                                   line)\r
-        if '\t' in line:\r
+        if self.force_notabs and '\t' in line:\r
             self.added_line_error('Tab character used', line)\r
         if len(stripped) < len(line):\r
             self.added_line_error('Trailing whitespace found', line)\r