On 17.06.21 02:17, Martin Sebor via Gcc wrote:
@@ -147,6 +152,12 @@ def generate_changelog(data, no_functions=False, fill_pr_titles=False):# Extract PR entries from newly added tests if 'testsuite' in file.path and file.is_added_file: + name = os.path.basename(file.path) + name = os.path.splitext(name)[0] + if name.startswith("pr"): + name = name[2:] + name = "PR " + name + prs.append(name)
I think you need a regular expression to extract the PR – as it will both match too much and to little. We have file names such as: * libstdc++-pr91488.C (other prefix) * PR37039.f90 (capitalized PR) * pr98218-1.C (suffix with '-') * pr40724_1.f (suffix with '_') * pr101023a.C (suffix with a letter) But otherwise, I like that idea. * * * Changes in my patch compared to v1: - (From Martin's patch:) Extract the PR from new-files file name (using pattern matching), but only take the PR if the PR wasn't found in the file as PR comment. (The latter happens, e.g., with b376b1ef389.) - Avoid printing the same PR multiple times as summary line (duplicates occur due to 'PR 134' vs. 'PR comp/123' vs. 'PR othercomp/123') — This does not avoid all issues but at least some. If this becomes a real world issue, we can try harder. OK to commit this one? — Comments? * * * I did leave out other changes as they seem to be less clear cut, and which can be still be handled as follow up. Like: - Adding 'Resolves:' (as in some cases it only resolves part of the PR) - ... other changes/patches I missed. (This thread has too many emails.) In particular, if ^PR <comp>/<pr> - .... is accepted by gcc-commit/, then there is no need to list the PRs individually later on. But currently, it is still required. * * * Cross ref: * v1 of my patch was at https://gcc.gnu.org/pipermail/gcc/2021-June/236498.html * Discussion of the -b option is at https://gcc.gnu.org/pipermail/gcc/2021-June/236519.html * Martin S's patch (partially quoted above) is at https://gcc.gnu.org/pipermail/gcc/2021-June/236460.html Tobias ----------------- Mentor Graphics (Deutschland) GmbH, Arnulfstrasse 201, 80634 München Registergericht München HRB 106955, Geschäftsführer: Thomas Heurung, Frank Thürauf
contrib/mklog.py: Improve PR handling Co-authored-by: Martin Sebor <[email protected]> contrib/ChangeLog: * mklog.py (bugzilla_url): Fetch also component. (pr_filename_regex): New. (get_pr_titles): Update PR string with correct format and component. (generate_changelog): Take additional PRs; extract PR from the filename. (__main__): Add -b/--pr-numbers argument. contrib/mklog.py | 41 ++++++++++++++++++++++++++++++++--------- 1 file changed, 32 insertions(+), 9 deletions(-) diff --git a/contrib/mklog.py b/contrib/mklog.py index 1f59055e723..bba6c1a0e1a 100755 --- a/contrib/mklog.py +++ b/contrib/mklog.py @@ -42,6 +42,7 @@ pr_regex = re.compile(r'(\/(\/|\*)|[Cc*!])\s+(?P<pr>PR [a-z+-]+\/[0-9]+)') prnum_regex = re.compile(r'PR (?P<comp>[a-z+-]+)/(?P<num>[0-9]+)') dr_regex = re.compile(r'(\/(\/|\*)|[Cc*!])\s+(?P<dr>DR [0-9]+)') dg_regex = re.compile(r'{\s+dg-(error|warning)') +pr_filename_regex = re.compile(r'(^|[\W_])[Pp][Rr](?P<pr>\d{4,})') identifier_regex = re.compile(r'^([a-zA-Z0-9_#].*)') comment_regex = re.compile(r'^\/\*') struct_regex = re.compile(r'^(class|struct|union|enum)\s+' @@ -52,7 +53,7 @@ fn_regex = re.compile(r'([a-zA-Z_][^()\s]*)\s*\([^*]') template_and_param_regex = re.compile(r'<[^<>]*>') md_def_regex = re.compile(r'\(define.*\s+"(.*)"') bugzilla_url = 'https://gcc.gnu.org/bugzilla/rest.cgi/bug?id=%s&;' \ - 'include_fields=summary' + 'include_fields=summary,component' function_extensions = {'.c', '.cpp', '.C', '.cc', '.h', '.inc', '.def', '.md'} @@ -118,20 +119,23 @@ def sort_changelog_files(changed_file): def get_pr_titles(prs): - output = '' - for pr in prs: + output = [] + for idx, pr in enumerate(prs): pr_id = pr.split('/')[-1] r = requests.get(bugzilla_url % pr_id) bugs = r.json()['bugs'] if len(bugs) == 1: - output += '%s - %s\n' % (pr, bugs[0]['summary']) - print(output) + prs[idx] = 'PR %s/%s' % (bugs[0]['component'], pr_id) + out = '%s - %s\n' % (prs[idx], bugs[0]['summary']) + if out not in output: + output.append(out) if output: - output += '\n' - return output + output.append('') + return '\n'.join(output) -def generate_changelog(data, no_functions=False, fill_pr_titles=False): +def generate_changelog(data, no_functions=False, fill_pr_titles=False, + additional_prs=None): changelogs = {} changelog_list = [] prs = [] @@ -139,6 +143,8 @@ def generate_changelog(data, no_functions=False, fill_pr_titles=False): diff = PatchSet(data) global firstpr + if additional_prs: + prs = [pr for pr in additional_prs if pr not in prs] for file in diff: # skip files that can't be parsed if file.path == '/dev/null': @@ -154,21 +160,33 @@ def generate_changelog(data, no_functions=False, fill_pr_titles=False): # Only search first ten lines as later lines may # contains commented code which a note that it # has not been tested due to a certain PR or DR. + this_file_prs = [] for line in list(file)[0][0:10]: m = pr_regex.search(line.value) if m: pr = m.group('pr') if pr not in prs: prs.append(pr) + this_file_prs.append(pr.split('/')[-1]) else: m = dr_regex.search(line.value) if m: dr = m.group('dr') if dr not in prs: prs.append(dr) + this_file_prs.append(dr.split('/')[-1]) elif dg_regex.search(line.value): # Found dg-warning/dg-error line break + # PR number in the file name + fname = os.path.basename(file.path) + fname = os.path.splitext(fname)[0] + m = pr_filename_regex.search(fname) + if m: + pr = m.group('pr') + pr2 = "PR " + pr + if pr not in this_file_prs and pr2 not in prs: + prs.append(pr2) if prs: firstpr = prs[0] @@ -286,6 +304,8 @@ if __name__ == '__main__': parser = argparse.ArgumentParser(description=help_message) parser.add_argument('input', nargs='?', help='Patch file (or missing, read standard input)') + parser.add_argument('-b', '--pr-numbers', action='append', + help='Add the specified PRs (comma separated)') parser.add_argument('-s', '--no-functions', action='store_true', help='Do not generate function names in ChangeLogs') parser.add_argument('-p', '--fill-up-bug-titles', action='store_true', @@ -308,8 +328,11 @@ if __name__ == '__main__': if args.update_copyright: update_copyright(data) else: + pr_numbers = args.pr_numbers + if pr_numbers: + pr_numbers = [b for i in args.pr_numbers for b in i.split(',')] output = generate_changelog(data, args.no_functions, - args.fill_up_bug_titles) + args.fill_up_bug_titles, pr_numbers) if args.changelog: lines = open(args.changelog).read().split('\n') start = list(takewhile(lambda l: not l.startswith('#'), lines))
