1 #!/usr/bin/env python2.7
3 # Copyright (c) 2019 Inria
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions are
8 # met: redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer;
10 # redistributions in binary form must reproduce the above copyright
11 # notice, this list of conditions and the following disclaimer in the
12 # documentation and/or other materials provided with the distribution;
13 # neither the name of the copyright holders nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 # Authors: Daniel Carvalho
31 # If your commit has been canceled because of this file, do not panic: a
32 # copy of it has been stored in ./.git/COMMIT_EDITMSG
38 from style
.repo
import GitRepo
40 def _printErrorQuit(error_message
):
42 Print an error message, followed my a help message and inform failure.
44 @param error_message A message describing the error that caused the
49 print("The commit has been cancelled, but a copy of it can be found in "
50 + sys
.argv
[1] + " : ")
53 --------------------------------------------------------------------------
55 print(open(sys
.argv
[1], "r").read())
57 --------------------------------------------------------------------------
61 The first line of a commit must contain one or more gem5 tags separated by
62 commas (see MAINTAINERS for the possible tags), followed by a colon and a
63 commit title. There must be no leading nor trailing whitespaces.
65 This header line must then be followed by an empty line. A detailed message,
66 although highly recommended, is not mandatory and can follow that empty line.
69 cpu: Refactor branch predictors
71 Refactor branch predictor code to improve its readability, moving functions
72 X and Y to the base class...
75 mem,mem-cache: Improve packet class readability
81 def _validateTags(commit_header
):
83 Check if all tags in the commit header belong to the list of valid
86 @param commit_header The first line of the commit message.
90 # @todo this is error prone, and should be extracted automatically from
93 valid_tags
= ["arch", "arch-alpha", "arch-arm", "arch-hsail", "arch-mips",
94 "arch-power", "arch-riscv", "arch-sparc", "arch-x86", "base",
95 "configs", "cpu", "cpu-kvm", "cpu-minor", "cpu-o3", "cpu-simple",
96 "dev", "dev-arm", "dev-virtio", "ext", "fastmodel", "gpu-compute",
97 "learning-gem5", "mem", "mem-cache", "mem-garnet", "mem-ruby", "misc",
98 "python", "scons", "sim", "sim-se", "sim-power", "stats", "system",
99 "system-alpha", "system-arm", "systemc", "tests", "util", "RFC", "WIP"]
101 tags
= ''.join(commit_header
.split(':')[0].split()).split(',')
102 if (any(tag
not in valid_tags
for tag
in tags
)):
103 invalid_tag
= next((tag
for tag
in tags
if tag
not in valid_tags
))
104 _printErrorQuit("Invalid Gem5 tag: " + invalid_tag
)
106 # Go to git directory
107 os
.chdir(GitRepo().repo_base())
109 # Get the commit message
110 commit_message
= open(sys
.argv
[1]).read()
112 # The first line of a commit must contain at least one valid gem5 tag, and
114 commit_message_lines
= commit_message
.splitlines()
115 commit_header
= commit_message_lines
[0]
116 commit_header_match
= \
117 re
.search("^(\S[\w\-][,\s*[\w\-]+]*:.+\S$)", commit_header
)
118 if ((commit_header_match
is None)):
119 _printErrorQuit("Invalid commit header")
120 _validateTags(commit_header
)
122 # Make sure commit title does not exceed threshold. This line is limited to
123 # a smaller number because version control systems may add a prefix, causing
124 # line-wrapping for longer lines
125 commit_title
= commit_header
.split(':')[1]
127 if (len(commit_header
) > max_header_size
):
128 _printErrorQuit("The commit header (tags + title) is too long (" + \
129 str(len(commit_header
)) + " > " + str(max_header_size
) + ")")
131 # Then there must be at least one empty line between the commit header and
132 # the commit description
133 if (commit_message_lines
[1] != ""):
134 _printErrorQuit("Please add an empty line between the commit title and " \
137 # Encourage providing descriptions
138 if (re
.search("^(Signed-off-by|Change-Id|Reviewed-by):",
139 commit_message_lines
[2])):
140 print("Warning: Commit does not have a description")