git.py revision 12558 
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
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Copyright (c) 2011 Advanced Micro Devices, Inc.
14# Copyright (c) 2009 The Hewlett-Packard Development Company
15# Copyright (c) 2004-2005 The Regents of The University of Michigan
16# All rights reserved.
17#
18# Redistribution and use in source and binary forms, with or without
19# modification, are permitted provided that the following conditions are
20# met: redistributions of source code must retain the above copyright
21# notice, this list of conditions and the following disclaimer;
22# redistributions in binary form must reproduce the above copyright
23# notice, this list of conditions and the following disclaimer in the
24# documentation and/or other materials provided with the distribution;
25# neither the name of the copyright holders nor the names of its
26# contributors may be used to endorse or promote products derived from
27# this software without specific prior written permission.
28#
29# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
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
41from __future__ import print_function
42import os
43
44import gem5_scons.util
45from m5.util import readCommand
46
47git_style_message = """
48You're missing the gem5 style or commit message hook. These hooks help
49to ensure that your code follows gem5's style rules on git commit.
50This script will now install the hook in your .git/hooks/ directory.
51Press enter to continue, or ctrl-c to abort: """
52
53def install_style_hooks(env):
54    try:
55        gitdir = env.Dir(readCommand(
56            ["git", "rev-parse", "--git-dir"]).strip("\n"))
57    except Exception, e:
58        print("Warning: Failed to find git repo directory: %s" % e)
59        return
60
61    git_hooks = gitdir.Dir("hooks")
62    def hook_exists(hook_name):
63        hook = git_hooks.File(hook_name)
64        return hook.exists()
65
66    def hook_install(hook_name, script):
67        hook = git_hooks.File(hook_name)
68        if hook.exists():
69            print("Warning: Can't install %s, hook already exists." %
70                    hook_name)
71            return
72
73        if hook.islink():
74            print("Warning: Removing broken symlink for hook %s." % hook_name)
75            os.unlink(hook.get_abspath())
76
77        if not git_hooks.exists():
78            os.mkdir(git_hooks.get_abspath())
79            git_hooks.clear()
80
81        abs_symlink_hooks = git_hooks.islink() and \
82            os.path.isabs(os.readlink(git_hooks.get_abspath()))
83
84        # Use a relative symlink if the hooks live in the source directory,
85        # and the hooks directory is not a symlink to an absolute path.
86        if hook.is_under(env.root) and not abs_symlink_hooks:
87            script_path = os.path.relpath(
88                os.path.realpath(script.get_abspath()),
89                os.path.realpath(hook.Dir(".").get_abspath()))
90        else:
91            script_path = script.get_abspath()
92
93        try:
94            os.symlink(script_path, hook.get_abspath())
95        except:
96            print("Error updating git %s hook" % hook_name)
97            raise
98
99    if hook_exists("pre-commit") and hook_exists("commit-msg"):
100        return
101
102    print(git_style_message, end=' ')
103    try:
104        raw_input()
105    except:
106        print("Input exception, exiting scons.\n")
107        sys.exit(1)
108
109    git_style_script = env.root.Dir("util").File("git-pre-commit.py")
110    git_msg_script = env.root.Dir("ext").File("git-commit-msg")
111
112    hook_install("pre-commit", git_style_script)
113    hook_install("commit-msg", git_msg_script)
114
115def generate(env):
116    if exists(env) and not gem5_scons.util.ignore_style():
117        install_style_hooks(env)
118
119def exists(env):
120    return env.Entry('#.git').exists()
121