1 #!/usr/bin/env python2.7
3 # Copyright (c) 2016 ARM Limited
6 # The license below extends only to copyright in the software and shall
7 # not be construed as granting a license to any other intellectual
8 # property including but not limited to intellectual property relating
9 # to a hardware implementation of the functionality of the software
10 # licensed hereunder. You may use the software subject to the license
11 # terms below provided that you ensure that this notice is replicated
12 # unmodified and in its entirety in all distributions of the software,
13 # modified or unmodified, in source code or in binary form.
15 # Redistribution and use in source and binary forms, with or without
16 # modification, are permitted provided that the following conditions are
17 # met: redistributions of source code must retain the above copyright
18 # notice, this list of conditions and the following disclaimer;
19 # redistributions in binary form must reproduce the above copyright
20 # notice, this list of conditions and the following disclaimer in the
21 # documentation and/or other materials provided with the distribution;
22 # neither the name of the copyright holders nor the names of its
23 # contributors may be used to endorse or promote products derived from
24 # this software without specific prior written permission.
26 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 from tempfile
import TemporaryFile
43 from style
.repo
import GitRepo
44 from style
.verifiers
import all_verifiers
, all_regions
45 from style
.style
import StdioUI
, check_ignores
49 parser
= argparse
.ArgumentParser(
50 description
="gem5 git style checker hook")
52 parser
.add_argument("--verbose", "-v", action
="store_true",
53 help="Produce verbose output")
55 args
= parser
.parse_args()
60 repo_base
= git
.repo_base()
65 staged_mismatch
= set()
67 for status
, fname
in git
.status(filter="MA", cached
=True):
69 print "Checking %s..." % fname
70 if check_ignores(fname
):
73 regions
= git
.staged_regions(fname
)
77 # Show they appropriate object and dump it to a file
78 status
= git
.file_from_index(fname
)
82 verifiers
= [ v(ui
, opts
, base
=repo_base
) for v
in all_verifiers
]
85 # It is prefered that the first check is silent as it is in the
86 # staged file. If the check fails, then we will do it non-silently
87 # on the current file, reporting meaningful shortcomings
88 if not v
.skip(fname
) and v
.check(fname
, regions
, fobj
=f
, silent
=True):
89 failing_files
.add(fname
)
90 if not v
.check(fname
, regions
):
91 staged_mismatch
.add(fname
)
95 if len(failing_files
) > len(staged_mismatch
):
97 print >> sys
.stderr
, "Style checker failed for the following files:"
98 for f
in failing_files
:
99 if f
not in staged_mismatch
:
100 print >> sys
.stderr
, "\t%s" % f
102 print >> sys
.stderr
, \
103 "Please run the style checker manually to fix the offending files.\n" \
104 "To check your modifications, run: util/style.py -m"
108 print >> sys
.stderr
, \
109 "It looks like you have forgotten to stage your fixes for commit in\n"\
110 "the following files: "
111 for f
in staged_mismatch
:
112 print >> sys
.stderr
, "\t%s" % f
113 print >> sys
.stderr
, "Please `git --add' them"