1# Copyright (c) 2013, 2015-2017 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder. You may use the software subject to the license

--- 24 unchanged lines hidden (view full) ---

33# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40
41import os
42
43import gem5_scons.util
44from m5.util import readCommand
45
46git_style_message = """
47You're missing the gem5 style or commit message hook. These hooks help
48to ensure that your code follows gem5's style rules on git commit.
49This script will now install the hook in your .git/hooks/ directory.
50Press enter to continue, or ctrl-c to abort: """
51
52def install_style_hooks(env):
53 try:
54 gitdir = env.Dir(readCommand(
55 ["git", "rev-parse", "--git-dir"]).strip("\n"))
56 except Exception, e:
57 print "Warning: Failed to find git repo directory: %s" % e
58 return
59
60 git_hooks = gitdir.Dir("hooks")
61 def hook_exists(hook_name):
62 hook = git_hooks.File(hook_name)
63 return hook.exists()
64
65 def hook_install(hook_name, script):
66 hook = git_hooks.File(hook_name)
67 if hook.exists():
68 print "Warning: Can't install %s, hook already exists." % hook_name
69 return
70
71 if hook.islink():
72 print "Warning: Removing broken symlink for hook %s." % hook_name
73 os.unlink(hook.get_abspath())
74
75 if not git_hooks.exists():
76 os.mkdir(git_hooks.get_abspath())
77 git_hooks.clear()
78
79 abs_symlink_hooks = git_hooks.islink() and \
80 os.path.isabs(os.readlink(git_hooks.get_abspath()))

--- 5 unchanged lines hidden (view full) ---

86 os.path.realpath(script.get_abspath()),
87 os.path.realpath(hook.Dir(".").get_abspath()))
88 else:
89 script_path = script.get_abspath()
90
91 try:
92 os.symlink(script_path, hook.get_abspath())
93 except:
94 print "Error updating git %s hook" % hook_name
95 raise
96
97 if hook_exists("pre-commit") and hook_exists("commit-msg"):
98 return
99
100 print git_style_message,
101 try:
102 raw_input()
103 except:
104 print "Input exception, exiting scons.\n"
105 sys.exit(1)
106
107 git_style_script = env.root.Dir("util").File("git-pre-commit.py")
108 git_msg_script = env.root.Dir("ext").File("git-commit-msg")
109
110 hook_install("pre-commit", git_style_script)
111 hook_install("commit-msg", git_msg_script)
112
113def generate(env):
114 if exists(env) and not gem5_scons.util.ignore_style():
115 install_style_hooks(env)
116
117def exists(env):
118 return env.Entry('#.git').exists()