From 93e20c9a73523f2b95fc65b99a0192f83eb7d8f4 Mon Sep 17 00:00:00 2001 From: Andreas Sandberg Date: Sun, 5 Feb 2017 05:00:38 +0000 Subject: scons: Automatically add a git commit message hook Gerrit requires that all commit messages have a Change-Id tag. This tag is added automatically by a commit message hook in Git. Include the default Gerrit commit message hook and add it automatically using scons to make life easier for everyone. Change-Id: I1270fbaaadf6ed151bddf14521a38e0c1a02d131 Signed-off-by: Andreas Sandberg Reviewed-on: https://gem5-review.googlesource.com/2166 Reviewed-by: Jason Lowe-Power Maintainer: Jason Lowe-Power --- SConstruct | 64 +++++++++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 42 insertions(+), 22 deletions(-) (limited to 'SConstruct') diff --git a/SConstruct b/SConstruct index e728e51fd..d405781d4 100755 --- a/SConstruct +++ b/SConstruct @@ -268,10 +268,17 @@ against the gem5 style rules on %s. This script will now install the hook in your %s. Press enter to continue, or ctrl-c to abort: """ -mercurial_style_message = style_message % ("hg commit and qrefresh commands", - ".hg/hgrc file") -git_style_message = style_message % ("'git commit'", - ".git/hooks/ directory") +mercurial_style_message = """ +You're missing the gem5 style hook, which automatically checks your code +against the gem5 style rules on hg commit and qrefresh commands. +This script will now install the hook in your .hg/hgrc file. +Press enter to continue, or ctrl-c to abort: """ + +git_style_message = """ +You're missing the gem5 style or commit message hook. These hooks help +to ensure that your code follows gem5's style rules on git commit. +This script will now install the hook in your .git/hooks/ directory. +Press enter to continue, or ctrl-c to abort: """ mercurial_style_upgrade_message = """ Your Mercurial style hooks are not up-to-date. This script will now @@ -376,10 +383,34 @@ def install_git_style_hooks(): return git_hooks = gitdir.Dir("hooks") - git_pre_commit_hook = git_hooks.File("pre-commit") - git_style_script = File("util/git-pre-commit.py") + def hook_exists(hook_name): + hook = git_hooks.File(hook_name) + return hook.exists() + + def hook_install(hook_name, script): + hook = git_hooks.File(hook_name) + if hook.exists(): + print "Warning: Can't install %s, hook already exists." % hook_name + return + + if not git_hooks.exists(): + mkdir(git_hooks.get_abspath()) + + # Use a relative symlink if the hooks live in the source directory + if hook.is_under(main.root): + script_path = os.path.relpath( + script.get_abspath(), + hook.Dir(".").get_abspath()) + else: + script_path = script.get_abspath() - if git_pre_commit_hook.exists(): + try: + os.symlink(script_path, hook.get_abspath()) + except: + print "Error updating git %s hook" % hook_name + raise + + if hook_exists("pre-commit") and hook_exists("commit-msg"): return print git_style_message, @@ -389,22 +420,11 @@ def install_git_style_hooks(): print "Input exception, exiting scons.\n" sys.exit(1) - if not git_hooks.exists(): - mkdir(git_hooks.get_abspath()) - - # Use a relative symlink if the hooks live in the source directory - if git_pre_commit_hook.is_under(main.root): - script_path = os.path.relpath( - git_style_script.get_abspath(), - git_pre_commit_hook.Dir(".").get_abspath()) - else: - script_path = git_style_script.get_abspath() + git_style_script = File("util/git-pre-commit.py") + git_msg_script = File("ext/git-commit-msg") - try: - os.symlink(script_path, git_pre_commit_hook.get_abspath()) - except: - print "Error updating git pre-commit hook" - raise + hook_install("pre-commit", git_style_script) + hook_install("commit-msg", git_msg_script) # Try to wire up git to the style hooks if not ignore_style and main.root.Entry(".git").exists(): -- cgit v1.2.3