git-backport: support renamed .cc files in commit message.
Commit Message
Hi.
There's a patch that enhances git-backport so that it updates commit
messages for files which name ends now with .cc and is still .c on a branch.
Example usage:
$ git show test
commit 8ed4b2cb9aa158c0ef418fd1ac66271664904604 (test)
Author: Martin Liska <mliska@suse.cz>
Date: Wed Jan 12 16:08:13 2022 +0100
Fix file.
gcc/ChangeLog:
* ipa-icf.cc: Test me.
gcc/ada/ChangeLog:
* cal.c: aaa.
libcpp/ChangeLog:
* expr.cc: aaa.
$ git gcc-backport test
Auto-merging gcc/ada/cal.c
Auto-merging gcc/ipa-icf.c
Auto-merging libcpp/expr.c
[test2 ee40feb077e] Fix file.
Date: Wed Jan 12 16:08:13 2022 +0100
3 files changed, 3 insertions(+)
Commit message updated: 2 .cc file(s) changed.
$ git show test2
commit f59a1e736c1b68f07d83388a994df8d043e8aa6e (test2)
Author: Martin Liska <mliska@suse.cz>
Date: Wed Jan 12 16:08:13 2022 +0100
Fix file.
gcc/ChangeLog:
* ipa-icf.c: Test me.
gcc/ada/ChangeLog:
* cal.c: aaa.
libcpp/ChangeLog:
* expr.c: aaa.
(cherry picked from commit 8ed4b2cb9aa158c0ef418fd1ac66271664904604)
Martin
Comments
On Wed, 12 Jan 2022 16:54:46 +0100
Martin Liška <mliska@suse.cz> wrote:
> +def replace_file_in_changelog(lines, filename):
> + if not filename.endswith('.cc'):
> + return
> +
> + # consider all componenets of a path: gcc/ipa-icf.cc
> + while filename:
> + for i, line in enumerate(lines):
> + if filename in line:
> + line = line.replace(filename, filename[:-1])
> + lines[i] = line
> + return
> + parts = filename.split('/')
> + if len(parts) == 1:
> + return
> + filename = '/'.join(parts[1:])
> +
I think you mean os.sep instead of the hardcoded slash.
But i'd use os.path.split and os.path.join
thanks,
On 1/14/22 08:44, Bernhard Reutner-Fischer wrote:
> On Wed, 12 Jan 2022 16:54:46 +0100
> Martin Liška <mliska@suse.cz> wrote:
>
>> +def replace_file_in_changelog(lines, filename):
>> + if not filename.endswith('.cc'):
>> + return
>> +
>> + # consider all componenets of a path: gcc/ipa-icf.cc
>> + while filename:
>> + for i, line in enumerate(lines):
>> + if filename in line:
>> + line = line.replace(filename, filename[:-1])
>> + lines[i] = line
>> + return
>> + parts = filename.split('/')
>> + if len(parts) == 1:
>> + return
>> + filename = '/'.join(parts[1:])
>> +
>
> I think you mean os.sep instead of the hardcoded slash.
> But i'd use os.path.split and os.path.join
Hello.
Well, these are all paths from a git commit message. And we require unix-style
of paths for all ChangeLog entries. So it should be correct.
Martin
>
> thanks,
On 1/12/22 16:54, Martin Liška wrote:
>
> There's a patch that enhances git-backport so that it updates commit
> messages for files which name ends now with .cc and is still .c on a branch.
The patch has been installed as I've made the renaming now.
Cheers,
Martin
Am 17.01.22 um 22:26 schrieb Martin Liška:
> On 1/12/22 16:54, Martin Liška wrote:
>>
>> There's a patch that enhances git-backport so that it updates commit
>> messages for files which name ends now with .cc and is still .c on a branch.
>>
>
> The patch has been installed as I've made the renaming now.
>
> Cheers,
> Martin
>
I just made a "git rebase" and had to manually fix the filenames
in the commit message. Otherwise gcc-verify would complain.
Would it make sense to have something that is clever enough for
rebase to do similar things as git-backport?
Thanks,
Harald
On 1/18/22 20:10, Harald Anlauf via Fortran wrote:
> Am 17.01.22 um 22:26 schrieb Martin Liška:
>> On 1/12/22 16:54, Martin Liška wrote:
>>>
>>> There's a patch that enhances git-backport so that it updates commit
>>> messages for files which name ends now with .cc and is still .c on a branch.
>>
>> The patch has been installed as I've made the renaming now.
>>
>> Cheers,
>> Martin
>>
>
> I just made a "git rebase" and had to manually fix the filenames
> in the commit message. Otherwise gcc-verify would complain.
Sure and I'm adding a new script that basically follows all the 'did you mean'
in gcc-verify and fixes that:
ERR: unchanged file mentioned in a ChangeLog (did you mean "contrib/gcc-git-customization.sh"?): "contrib/gcc2-git-customization.sh"
...
>
> Would it make sense to have something that is clever enough for
> rebase to do similar things as git-backport?
Yes, a new git alias 'gcc-fix-changelog' is going to be available with the patch.
Martin
>
> Thanks,
> Harald
>
From 647a6dbaf8cde4ee07b95c4530a03f7774500914 Mon Sep 17 00:00:00 2001
From: Martin Liska <mliska@suse.cz>
Date: Wed, 12 Jan 2022 16:35:41 +0100
Subject: [PATCH] git-backport: support renamed .cc files in commit message.
The change can automatically update names for *.cc files that
are part of a backport.
contrib/ChangeLog:
* git-backport.py: Support renaming of .cc files.
---
contrib/git-backport.py | 50 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 50 insertions(+)
@@ -20,7 +20,32 @@
# Boston, MA 02110-1301, USA.
import argparse
+import os
import subprocess
+import sys
+import tempfile
+
+script_folder = os.path.dirname(os.path.abspath(__file__))
+verify_script = os.path.join(script_folder,
+ 'gcc-changelog/git_check_commit.py')
+
+
+def replace_file_in_changelog(lines, filename):
+ if not filename.endswith('.cc'):
+ return
+
+ # consider all componenets of a path: gcc/ipa-icf.cc
+ while filename:
+ for i, line in enumerate(lines):
+ if filename in line:
+ line = line.replace(filename, filename[:-1])
+ lines[i] = line
+ return
+ parts = filename.split('/')
+ if len(parts) == 1:
+ return
+ filename = '/'.join(parts[1:])
+
if __name__ == '__main__':
parser = argparse.ArgumentParser(description='Backport a git revision and '
@@ -63,3 +88,28 @@ if __name__ == '__main__':
subprocess.check_output(cmd, shell=True)
else:
print('Please resolve all remaining file conflicts.')
+ sys.exit(1)
+
+ # Update commit message if change for a .cc file was taken
+ r = subprocess.run(f'{verify_script} HEAD', shell=True, encoding='utf8',
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ if r.returncode != 0:
+ lines = r.stdout.splitlines()
+ cmd = 'git show -s --format=%B'
+ commit_message = subprocess.check_output(cmd, shell=True,
+ encoding='utf8').strip()
+ commit_message = commit_message.splitlines()
+
+ todo = [line for line in lines if 'unchanged file mentioned' in line]
+ for item in todo:
+ filename = item.split()[-1].strip('"')
+ replace_file_in_changelog(commit_message, filename)
+
+ with tempfile.NamedTemporaryFile('w', encoding='utf8',
+ delete=False) as w:
+ w.write('\n'.join(commit_message))
+ w.close()
+ subprocess.check_output(f'git commit --amend -F {w.name}',
+ shell=True, encoding='utf8')
+ os.unlink(w.name)
+ print(f'Commit message updated: {len(todo)} .cc file(s) changed.')
--
2.34.1