From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 95584821F1 for ; Tue, 13 Dec 2016 23:01:02 -0800 (PST) Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by fmsmga103.fm.intel.com with ESMTP; 13 Dec 2016 23:01:01 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,345,1477983600"; d="scan'208";a="42403970" Received: from fmsmsx103.amr.corp.intel.com ([10.18.124.201]) by fmsmga006.fm.intel.com with ESMTP; 13 Dec 2016 23:01:01 -0800 Received: from shsmsx152.ccr.corp.intel.com (10.239.6.52) by FMSMSX103.amr.corp.intel.com (10.18.124.201) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 13 Dec 2016 23:01:00 -0800 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.9]) by SHSMSX152.ccr.corp.intel.com ([169.254.6.235]) with mapi id 14.03.0248.002; Wed, 14 Dec 2016 15:00:58 +0800 From: "Gao, Liming" To: Daniil Egranov , "edk2-devel@lists.01.org" CC: "leif.lindholm@linaro.org" Thread-Topic: [edk2] [PATCH v5] BaseTools/Scripts/PatchCheck.py: Extended patch style check for c code Thread-Index: AQHSVUtg2F5OalcddU6e/JEhaQ+P26EHAffQ Date: Wed, 14 Dec 2016 07:00:58 +0000 Message-ID: <4A89E2EF3DFEDB4C8BFDE51014F606A14D6A4D05@SHSMSX104.ccr.corp.intel.com> References: <1481638518-37028-1-git-send-email-daniil.egranov@arm.com> In-Reply-To: <1481638518-37028-1-git-send-email-daniil.egranov@arm.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [PATCH v5] BaseTools/Scripts/PatchCheck.py: Extended patch style check for c code X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 14 Dec 2016 07:01:02 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Daniil: Could you update the script to print line number in source file instead = of diff file? Sometimes, the developer uses this script with revision. The = print line in the diff file is not obvious. And, I also find the report lin= e number is difference for the same patch with the two ways: PatchCheck.py= revision and PatchCheck.py 0001-xxxx.patch. So, I suggest to print the lin= e number in source file. Thanks Liming > -----Original Message----- > From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of > Daniil Egranov > Sent: Tuesday, December 13, 2016 10:15 PM > To: edk2-devel@lists.01.org > Cc: Gao, Liming ; leif.lindholm@linaro.org > Subject: [edk2] [PATCH v5] BaseTools/Scripts/PatchCheck.py: Extended > patch style check for c code >=20 > Corrected code checking for multi-line and commented lines. Both > multi-line and open comment flags will be reset when leaving > diff "+" area of the patch. > Changed version of the tool to 0.2. >=20 > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Daniil Egranov > --- > Changelog: >=20 > v4 > Corrected maximum code line size to 120 characters. >=20 > v3 > Corrected space detection before parentheses. >=20 > v2: > Fixed several indentation cases >=20 > v1: > Fixed reporting signature error for a cover letter. > Fixed reporting line size error for a file change information > included in the commit message. > Fixed line number reported in PatchCheck error messages. It > points to the correct line in the diff file. > The patch extends style checking for c code: > Added check for code indentation. > Added report line size greater than 80 characters. > Added checking for space before '('. > Added checking for space before '{'. > Added checking for '}' to be on a new line and have spaces > for "} else {" or "} while ()" cases. >=20 > BaseTools/Scripts/PatchCheck.py | 263 > ++++++++++++++++++++++++++++++++++++---- > 1 file changed, 238 insertions(+), 25 deletions(-) >=20 > diff --git a/BaseTools/Scripts/PatchCheck.py > b/BaseTools/Scripts/PatchCheck.py > index 7c30082..2406601 100755 > --- a/BaseTools/Scripts/PatchCheck.py > +++ b/BaseTools/Scripts/PatchCheck.py > @@ -15,7 +15,7 @@ >=20 > from __future__ import print_function >=20 > -VersionNumber =3D '0.1' > +VersionNumber =3D '0.2' > __copyright__ =3D "Copyright (c) 2015 - 2016, Intel Corporation All rig= hts > reserved." >=20 > import email > @@ -32,7 +32,7 @@ class Verbose: > class CommitMessageCheck: > """Checks the contents of a git commit message.""" >=20 > - def __init__(self, subject, message): > + def __init__(self, subject, message, message_offset, cover): > self.ok =3D True >=20 > if subject is None and message is None: > @@ -41,9 +41,15 @@ class CommitMessageCheck: >=20 > self.subject =3D subject > self.msg =3D message > + self.msg_offset =3D message_offset > + self.cover =3D cover > + > + if not cover: > + self.check_contributed_under() > + self.check_signed_off_by() > + else: > + print('The commit message is cover letter.') >=20 > - self.check_contributed_under() > - self.check_signed_off_by() > self.check_misc_signatures() > self.check_overall_format() > self.report_message_result() > @@ -180,6 +186,9 @@ class CommitMessageCheck: > for sig in self.sig_types: > self.find_signatures(sig) >=20 > + diff_change_info_re =3D \ > + re.compile(r'.*\|\s+(\d|Bin)*\s.*[\+\-]') > + > def check_overall_format(self): > lines =3D self.msg.splitlines() >=20 > @@ -197,9 +206,10 @@ class CommitMessageCheck: > self.error('Empty commit message!') > return >=20 > - if count >=3D 1 and len(lines[0]) >=3D 72: > + if count >=3D 1 and len(lines[0]) > 72: > self.error('First line of commit message (subject line) ' + > - 'is too long.') > + 'is too long (%d) (max 72 characters):' %(len(lin= es[0]))) > + print(lines[0], '\n') >=20 > if count >=3D 1 and len(lines[0].strip()) =3D=3D 0: > self.error('First line of commit message (subject line) ' + > @@ -210,10 +220,13 @@ class CommitMessageCheck: > 'empty.') >=20 > for i in range(2, count): > - if (len(lines[i]) >=3D 76 and > + if (len(lines[i]) > 76 and > len(lines[i].split()) > 1 and > - not lines[i].startswith('git-svn-id:')): > - self.error('Line %d of commit message is too long.' % (i= + 1)) > + not lines[i].startswith('git-svn-id:') and > + self.diff_change_info_re.search(lines[i]) is None): > + self.error('Line %d of commit message is too long (%d) (= max 76 > characters):' \ > + % (i + self.msg_offset - 1, len(lines[i]))) > + print(lines[i], '\n') >=20 > last_sig_line =3D None > for i in range(count - 1, 0, -1): > @@ -236,13 +249,18 @@ class CommitMessageCheck: > class GitDiffCheck: > """Checks the contents of a git diff.""" >=20 > - def __init__(self, diff): > + def __init__(self, diff, offset): > self.ok =3D True > self.format_ok =3D True > self.lines =3D diff.splitlines(True) > self.count =3D len(self.lines) > self.line_num =3D 0 > self.state =3D START > + self.comments_open =3D False > + self.multiline_string =3D False > + self.current_indent_size =3D 0 > + self.parentheses_count =3D 0 > + self.offset =3D offset > while self.line_num < self.count and self.format_ok: > line_num =3D self.line_num > self.run() > @@ -255,6 +273,12 @@ class GitDiffCheck: > if self.ok: > print('The code passed all checks.') >=20 > + def clean_counts(self): > + self.current_indent_size =3D -1 > + self.parentheses_count =3D 0 > + self.comments_open =3D False > + self.multiline_string =3D False > + > def run(self): > line =3D self.lines[self.line_num] >=20 > @@ -283,6 +307,20 @@ class GitDiffCheck: > elif self.state =3D=3D PRE_PATCH: > if line.startswith('+++ b/'): > self.set_filename(line[6:].rstrip()) > + print("Checking patch for %s ...\n" %(self.hunk_filename= )) > + if self.hunk_filename.endswith(".c") or \ > + self.hunk_filename.endswith(".h"): > + self.file_type =3D "c_type" > + elif self.hunk_filename.endswith(".dec") or \ > + self.hunk_filename.endswith(".dsc") or \ > + self.hunk_filename.endswith(".fdf"): > + self.file_type =3D "edk2_type" > + elif self.hunk_filename.endswith(".S"): > + self.file_type =3D "asm_arm_type" > + elif self.hunk_filename.endswith(".asm"): > + self.file_type =3D "asm_type" > + else: > + self.file_type =3D "other_type" > if line.startswith('@@ '): > self.state =3D PATCH > self.binary =3D False > @@ -296,18 +334,27 @@ class GitDiffCheck: > ok =3D True > if not ok: > self.format_error("didn't find diff hunk marker (@@)= ") > + > self.line_num +=3D 1 > elif self.state =3D=3D PATCH: > if self.binary: > + self.clean_counts() > pass > if line.startswith('-'): > + self.clean_counts() > pass > elif line.startswith('+'): > - self.check_added_line(line[1:]) > + # indentation resets every time we leave "+" diff area > + self.check_added_line(line[1:], self.line_num + self.off= set) > elif line.startswith(r'\ No newline '): > + self.clean_counts() > pass > elif not line.startswith(' '): > + self.clean_counts() > self.format_error("unexpected patch line") > + else: > + self.clean_counts() > + > self.line_num +=3D 1 >=20 > pre_patch_prefixes =3D ( > @@ -336,7 +383,7 @@ class GitDiffCheck: > lines =3D [ msg ] > if self.hunk_filename is not None: > lines.append('File: ' + self.hunk_filename) > - lines.append('Line: ' + line) > + lines.append('Line: ' + line + '\n') >=20 > self.error(*lines) >=20 > @@ -348,28 +395,171 @@ class GitDiffCheck: > ''', > re.VERBOSE) >=20 > - def check_added_line(self, line): > + space_check_parentheses_re =3D re.compile(r'[a-zA-Z0- > 9_]\S*\((? + space_check_brace_open_re =3D re.compile(r'[a-zA-Z0-9_]\S*\{') > + space_check_brace_close_re =3D re.compile(r'[\}]\S.*') > + brace_open_check_re =3D re.compile(r'[a-zA-Z0-9_]*\{') > + brace_close_check_re =3D re.compile(r'.*\}.*') > + multiline_check_re =3D re.compile(r'[a-zA-Z0-9_]*(\\|\&|\,|\+|\- > |\*|\||\=3D)\Z') > + > + def check_added_line(self, line, line_num): > eol =3D '' > for an_eol in self.line_endings: > if line.endswith(an_eol): > eol =3D an_eol > line =3D line[:-len(eol)] >=20 > - stripped =3D line.rstrip() > + # empty "+" line, skip it > + if len(line) =3D=3D 0: > + return > + > + rstripped =3D line.rstrip() > + lstripped =3D line.lstrip() >=20 > if self.force_crlf and eol !=3D '\r\n': > - self.added_line_error('Line ending (%s) is not CRLF' % repr(= eol), > + self.added_line_error('Line ending (%s) is not CRLF:' % repr= (eol), > line) > if '\t' in line: > - self.added_line_error('Tab character used', line) > - if len(stripped) < len(line): > - self.added_line_error('Trailing whitespace found', line) > + self.added_line_error('Tab character used at line %d:' \ > + %(line_num), line) > + if len(rstripped) < len(line): > + self.added_line_error('Trailing whitespace found at line %d:= ' \ > + %(line_num), line) > + # the file type specific checks > + if self.file_type =3D=3D "c_type": > + > + # set initial indentation as the number of spaces after the = first "+" > + # indentation does not apply on lines with 0 characters > + # adjust the indentation if first "+" has "}" > + if self.current_indent_size =3D=3D -1: > + if len(lstripped) !=3D 0: > + self.current_indent_size =3D len(line) - len(lstripp= ed) > + else: > + self.clean_counts() >=20 > - mo =3D self.old_debug_re.search(line) > - if mo is not None: > - self.added_line_error('EFI_D_' + mo.group(1) + ' was used, ' > - 'but DEBUG_' + mo.group(1) + > - ' is now recommended', line) > + if lstripped.startswith("}"): > + self.current_indent_size =3D line.find("}") + 2 > + > + indent_size =3D len(line) - len(lstripped) > + indent_size_adjust =3D 0 > + force_brace_check =3D False > + > + if len(line) > 120: > + self.added_line_error('Line %d is too long (%d) (max 120 > characters):' \ > + %(line_num, len(line)), line) > + > + # skip comments for code checking > + if lstripped.startswith("//"): > + return > + if lstripped.startswith("/*") and not self.comments_open: > + self.comments_open =3D True > + > + if rstripped.endswith("*/") and self.comments_open: > + self.comments_open =3D False > + return > + > + if rstripped.endswith("*/") and not self.comments_open: > + # found unknown close comment, reset the indentation as > + # no idea where it started > + self.current_indent_size =3D -1 > + return > + > + if not self.comments_open: > + mo =3D self.old_debug_re.search(line) > + if mo is not None: > + self.added_line_error('EFI_D_' + mo.group(1) + ' was= used, ' > + 'but DEBUG_' + mo.group(1) + > + ' is now recommended at line %d' \ > + %(line_num), line) > + > + # track down multiple braces in the same line > + braces_count =3D line.count('{') - line.count('}') > + > + # track down a special case with "} else ..{" braces > + if line.find("else") !=3D -1: > + force_brace_check =3D True > + > + # check for closing brace which affects indentation > + if braces_count < 0 and not force_brace_check: > + self.current_indent_size -=3D 2 * abs(braces_count) > + elif force_brace_check: > + if line.find("}") !=3D -1: > + self.current_indent_size -=3D 2 > + braces_count =3D 1 > + > + # for the switch()/case:, adjust "case:" and "default:" = indentation > + # as they aligned with the "switch()" indentation > + if lstripped.startswith("case ") or \ > + lstripped.startswith("default:"): > + indent_size_adjust =3D -2 > + > + # indentation code check related to the diff structure > + # do not check code indentation between parentheses > + if indent_size !=3D self.current_indent_size + indent_si= ze_adjust \ > + and len(line) !=3D 0 and self.parentheses_count =3D= =3D 0 \ > + and not self.multiline_string: > + self.added_line_error('Invalid indentation at li= ne %d. > Expecting %d but found %d spaces:' \ > + % (line_num, self.current_indent_size + indent_s= ize_adjust, \ > + indent_size), line) > + > + # check for missing space before open brace > + if braces_count > 0 or force_brace_check: > + if line.find("{") !=3D -1: > + self.current_indent_size +=3D 2 * braces_count > + if not line.startswith("{"): > + spb_check =3D self.space_check_brace_open_re.sea= rch(line) > + if spb_check is not None: > + self.added_line_error('Missing space before = \'{\' at line %d:' \ > + %(line_num), line) > + > + # check for missing space before open parenthesis > + spo =3D self.space_check_parentheses_re.search(line) > + if spo is not None and not self.multiline_string: > + # check if it's not inside of the double quoted stri= ng or > + # (aa)(bb)fff case > + text_str_start =3D line.find('\"') > + if not (text_str_start !=3D -1 and text_str_start < = spo.start()): > + self.added_line_error('Missing space before \'(\= ' at line %d:' \ > + %(line_num), line) > + > + # check for closing brace cases > + if braces_count < 0 or \ > + (force_brace_check and line.find("}") !=3D -1): > + if not lstripped.startswith("}") and rstripped.endsw= ith("}"): > + self.added_line_error('The \'}\' is not on its o= wn line at line %d:' > \ > + %(line_num), line) > + if not lstripped.endswith("}"): > + scb =3D self.space_check_brace_close_re.search(l= stripped) > + if scb is not None \ > + and lstripped[scb.start() + 1] !=3D ';' \ > + and lstripped[scb.start() + 1] !=3D ',' \ > + and lstripped[scb.start() + 1] !=3D '}': > + self.added_line_error('Missing space after \= '}\' at line %d:' \ > + %(line_num), line) > + > + # track down parentheses, no indentation check between t= hem > + if not (self.parentheses_count =3D=3D 0 and lstripped.st= artswith(')') \ > + and not self.multiline_string and not self.comme= nts_open): > + self.parentheses_count +=3D line.count('(') - line.c= ount(')') > + > + # multiline strings indentation is unknown > + if not self.comments_open: > + mlc =3D self.multiline_check_re.search(line) > + if mlc is not None: > + self.multiline_string =3D True > + else: > + self.multiline_string =3D False > + > + elif self.file_type =3D=3D "edk2_type": > + pass > + elif self.file_type =3D=3D "asm_arm_type": > + pass > + elif self.file_type =3D=3D "asm_type": > + pass > + elif self.file_type =3D=3D "other_type": > + pass > + else: > + pass >=20 > split_diff_re =3D re.compile(r''' > (?P > @@ -410,12 +600,13 @@ class CheckOnePatch: > self.patch =3D patch > self.find_patch_pieces() >=20 > - msg_check =3D CommitMessageCheck(self.commit_subject, > self.commit_msg) > + msg_check =3D CommitMessageCheck(self.commit_subject, > self.commit_msg, \ > + self.commit_msg_offset, self.cove= r) > msg_ok =3D msg_check.ok >=20 > diff_ok =3D True > if self.diff is not None: > - diff_check =3D GitDiffCheck(self.diff) > + diff_check =3D GitDiffCheck(self.diff, self.diff_offset) > diff_ok =3D diff_check.ok >=20 > self.ok =3D msg_ok and diff_ok > @@ -458,6 +649,16 @@ class CheckOnePatch: > ''', > re.VERBOSE) >=20 > + cover_letter_re =3D re.compile(r'Subject:\s*\[PATCH.*.0/.*', > + re.IGNORECASE | re.MULTILINE) > + > + def is_cover_letter(self, patch): > + cl =3D self.cover_letter_re.search(patch) > + if cl is None: > + return False > + > + return True > + > def find_patch_pieces(self): > if sys.version_info < (3, 0): > patch =3D self.patch.encode('ascii', 'ignore') > @@ -465,10 +666,13 @@ class CheckOnePatch: > patch =3D self.patch >=20 > self.commit_msg =3D None > + self.commit_msg_offset =3D 0 > self.stat =3D None > self.commit_subject =3D None > self.commit_prefix =3D None > self.diff =3D None > + self.diff_offset =3D 0 > + self.cover =3D False >=20 > if patch.startswith('diff --git'): > self.diff =3D patch > @@ -480,6 +684,14 @@ class CheckOnePatch: > assert(parts[0].get_content_type() =3D=3D 'text/plain') > content =3D parts[0].get_payload(decode=3DTrue).decode('utf-8', = 'ignore') >=20 > + # find offset of content > + self.commit_msg_offset =3D len(patch.splitlines()) - > len(content.splitlines()) > + > + # find offset of first diff section > + mo =3D self.git_diff_re.search(patch) > + if mo is not None: > + self.diff_offset =3D len(patch[:mo.start()].splitlines()) + = 1 > + > mo =3D self.git_diff_re.search(content) > if mo is not None: > self.diff =3D content[mo.start():] > @@ -492,6 +704,7 @@ class CheckOnePatch: > self.stat =3D mo.group('stat') > self.commit_msg =3D mo.group('commit_message') >=20 > + self.cover =3D self.is_cover_letter(patch) > self.commit_subject =3D pmail['subject'].replace('\r\n', '') > self.commit_subject =3D self.commit_subject.replace('\n', '') > self.commit_subject =3D self.subject_prefix_re.sub('', > self.commit_subject, 1) > -- > 2.7.4 >=20 > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel