blob: 67103f03e6959d32ebef5ebb5fc497cba4743957 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
Simon Glass0d24de92012-01-14 15:12:45 +00002# Copyright (c) 2011 The Chromium OS Authors.
3#
Simon Glass0d24de92012-01-14 15:12:45 +00004
Paul Burtona920a172016-09-27 16:03:50 +01005from __future__ import print_function
6
Doug Anderson31187252012-12-03 14:40:43 +00007import itertools
Simon Glass0d24de92012-01-14 15:12:45 +00008import os
9
Doug Anderson21a19d72012-12-03 14:43:16 +000010import get_maintainer
Simon Glass0d24de92012-01-14 15:12:45 +000011import gitutil
Chris Packhame11aa602017-09-01 20:57:53 +120012import settings
Simon Glass0d24de92012-01-14 15:12:45 +000013import terminal
Simon Glass513eace2019-05-14 15:53:50 -060014import tools
Simon Glass0d24de92012-01-14 15:12:45 +000015
16# Series-xxx tags that we understand
Simon Glassfe2f8d92013-03-20 16:43:00 +000017valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name',
Simon Glassd9917b02015-08-22 18:28:01 -060018 'cover_cc', 'process_log']
Simon Glass0d24de92012-01-14 15:12:45 +000019
20class Series(dict):
21 """Holds information about a patch series, including all tags.
22
23 Vars:
24 cc: List of aliases/emails to Cc all patches to
25 commits: List of Commit objects, one for each patch
26 cover: List of lines in the cover letter
27 notes: List of lines in the notes
28 changes: (dict) List of changes for each version, The key is
29 the integer version number
Simon Glassf0b739f2013-05-02 14:46:02 +000030 allow_overwrite: Allow tags to overwrite an existing tag
Simon Glass0d24de92012-01-14 15:12:45 +000031 """
32 def __init__(self):
33 self.cc = []
34 self.to = []
Simon Glassfe2f8d92013-03-20 16:43:00 +000035 self.cover_cc = []
Simon Glass0d24de92012-01-14 15:12:45 +000036 self.commits = []
37 self.cover = None
38 self.notes = []
39 self.changes = {}
Simon Glassf0b739f2013-05-02 14:46:02 +000040 self.allow_overwrite = False
Simon Glass0d24de92012-01-14 15:12:45 +000041
Doug Andersond94566a2012-12-03 14:40:42 +000042 # Written in MakeCcFile()
43 # key: name of patch file
44 # value: list of email addresses
45 self._generated_cc = {}
46
Simon Glass0d24de92012-01-14 15:12:45 +000047 # These make us more like a dictionary
48 def __setattr__(self, name, value):
49 self[name] = value
50
51 def __getattr__(self, name):
52 return self[name]
53
54 def AddTag(self, commit, line, name, value):
55 """Add a new Series-xxx tag along with its value.
56
57 Args:
58 line: Source line containing tag (useful for debug/error messages)
59 name: Tag name (part after 'Series-')
60 value: Tag value (part after 'Series-xxx: ')
61 """
62 # If we already have it, then add to our list
Simon Glassfe2f8d92013-03-20 16:43:00 +000063 name = name.replace('-', '_')
Simon Glassf0b739f2013-05-02 14:46:02 +000064 if name in self and not self.allow_overwrite:
Simon Glass0d24de92012-01-14 15:12:45 +000065 values = value.split(',')
66 values = [str.strip() for str in values]
67 if type(self[name]) != type([]):
68 raise ValueError("In %s: line '%s': Cannot add another value "
69 "'%s' to series '%s'" %
70 (commit.hash, line, values, self[name]))
71 self[name] += values
72
73 # Otherwise just set the value
74 elif name in valid_series:
Albert ARIBAUD070b7812016-02-02 10:24:53 +010075 if name=="notes":
76 self[name] = [value]
77 else:
78 self[name] = value
Simon Glass0d24de92012-01-14 15:12:45 +000079 else:
80 raise ValueError("In %s: line '%s': Unknown 'Series-%s': valid "
Simon Glassef0e9de2012-09-27 15:06:02 +000081 "options are %s" % (commit.hash, line, name,
Simon Glass0d24de92012-01-14 15:12:45 +000082 ', '.join(valid_series)))
83
84 def AddCommit(self, commit):
85 """Add a commit into our list of commits
86
87 We create a list of tags in the commit subject also.
88
89 Args:
90 commit: Commit object to add
91 """
92 commit.CheckTags()
93 self.commits.append(commit)
94
95 def ShowActions(self, args, cmd, process_tags):
96 """Show what actions we will/would perform
97
98 Args:
99 args: List of patch files we created
100 cmd: The git command we would have run
101 process_tags: Process tags as if they were aliases
102 """
Peter Tyser21818302015-01-26 11:42:21 -0600103 to_set = set(gitutil.BuildEmailList(self.to));
104 cc_set = set(gitutil.BuildEmailList(self.cc));
105
Simon Glass0d24de92012-01-14 15:12:45 +0000106 col = terminal.Color()
Paul Burtona920a172016-09-27 16:03:50 +0100107 print('Dry run, so not doing much. But I would do this:')
108 print()
109 print('Send a total of %d patch%s with %scover letter.' % (
Simon Glass0d24de92012-01-14 15:12:45 +0000110 len(args), '' if len(args) == 1 else 'es',
Paul Burtona920a172016-09-27 16:03:50 +0100111 self.get('cover') and 'a ' or 'no '))
Simon Glass0d24de92012-01-14 15:12:45 +0000112
113 # TODO: Colour the patches according to whether they passed checks
114 for upto in range(len(args)):
115 commit = self.commits[upto]
Paul Burtona920a172016-09-27 16:03:50 +0100116 print(col.Color(col.GREEN, ' %s' % args[upto]))
Doug Andersond94566a2012-12-03 14:40:42 +0000117 cc_list = list(self._generated_cc[commit.patch])
Simon Glassb644c662019-05-14 15:53:51 -0600118 for email in sorted(set(cc_list) - to_set - cc_set):
Simon Glass0d24de92012-01-14 15:12:45 +0000119 if email == None:
120 email = col.Color(col.YELLOW, "<alias '%s' not found>"
121 % tag)
122 if email:
Simon Glass6f8abf72017-05-29 15:31:23 -0600123 print(' Cc: ', email)
Simon Glass0d24de92012-01-14 15:12:45 +0000124 print
Simon Glassb644c662019-05-14 15:53:51 -0600125 for item in sorted(to_set):
Paul Burtona920a172016-09-27 16:03:50 +0100126 print('To:\t ', item)
Simon Glassb644c662019-05-14 15:53:51 -0600127 for item in sorted(cc_set - to_set):
Paul Burtona920a172016-09-27 16:03:50 +0100128 print('Cc:\t ', item)
129 print('Version: ', self.get('version'))
130 print('Prefix:\t ', self.get('prefix'))
Simon Glass0d24de92012-01-14 15:12:45 +0000131 if self.cover:
Paul Burtona920a172016-09-27 16:03:50 +0100132 print('Cover: %d lines' % len(self.cover))
Simon Glassfe2f8d92013-03-20 16:43:00 +0000133 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
134 all_ccs = itertools.chain(cover_cc, *self._generated_cc.values())
Simon Glassb644c662019-05-14 15:53:51 -0600135 for email in sorted(set(all_ccs) - to_set - cc_set):
Paul Burtona920a172016-09-27 16:03:50 +0100136 print(' Cc: ', email)
Simon Glass0d24de92012-01-14 15:12:45 +0000137 if cmd:
Paul Burtona920a172016-09-27 16:03:50 +0100138 print('Git command: %s' % cmd)
Simon Glass0d24de92012-01-14 15:12:45 +0000139
140 def MakeChangeLog(self, commit):
141 """Create a list of changes for each version.
142
143 Return:
144 The change log as a list of strings, one per line
145
Simon Glass27e97602012-10-30 06:15:16 +0000146 Changes in v4:
Otavio Salvador244e6f92012-08-18 07:46:04 +0000147 - Jog the dial back closer to the widget
148
Simon Glass27e97602012-10-30 06:15:16 +0000149 Changes in v3: None
150 Changes in v2:
Simon Glass0d24de92012-01-14 15:12:45 +0000151 - Fix the widget
152 - Jog the dial
153
Simon Glass0d24de92012-01-14 15:12:45 +0000154 etc.
155 """
156 final = []
Simon Glass645b2712013-03-26 13:09:44 +0000157 process_it = self.get('process_log', '').split(',')
158 process_it = [item.strip() for item in process_it]
Simon Glass0d24de92012-01-14 15:12:45 +0000159 need_blank = False
Otavio Salvador244e6f92012-08-18 07:46:04 +0000160 for change in sorted(self.changes, reverse=True):
Simon Glass0d24de92012-01-14 15:12:45 +0000161 out = []
162 for this_commit, text in self.changes[change]:
163 if commit and this_commit != commit:
164 continue
Simon Glass645b2712013-03-26 13:09:44 +0000165 if 'uniq' not in process_it or text not in out:
166 out.append(text)
Simon Glass27e97602012-10-30 06:15:16 +0000167 line = 'Changes in v%d:' % change
168 have_changes = len(out) > 0
Simon Glass645b2712013-03-26 13:09:44 +0000169 if 'sort' in process_it:
170 out = sorted(out)
Simon Glass27e97602012-10-30 06:15:16 +0000171 if have_changes:
172 out.insert(0, line)
173 else:
174 out = [line + ' None']
175 if need_blank:
176 out.insert(0, '')
177 final += out
178 need_blank = have_changes
Simon Glass0d24de92012-01-14 15:12:45 +0000179 if self.changes:
180 final.append('')
181 return final
182
183 def DoChecks(self):
184 """Check that each version has a change log
185
186 Print an error if something is wrong.
187 """
188 col = terminal.Color()
189 if self.get('version'):
190 changes_copy = dict(self.changes)
Otavio Salvadord5f81d82012-08-13 10:08:22 +0000191 for version in range(1, int(self.version) + 1):
Simon Glass0d24de92012-01-14 15:12:45 +0000192 if self.changes.get(version):
193 del changes_copy[version]
194 else:
Otavio Salvadord5f81d82012-08-13 10:08:22 +0000195 if version > 1:
196 str = 'Change log missing for v%d' % version
Paul Burtona920a172016-09-27 16:03:50 +0100197 print(col.Color(col.RED, str))
Simon Glass0d24de92012-01-14 15:12:45 +0000198 for version in changes_copy:
199 str = 'Change log for unknown version v%d' % version
Paul Burtona920a172016-09-27 16:03:50 +0100200 print(col.Color(col.RED, str))
Simon Glass0d24de92012-01-14 15:12:45 +0000201 elif self.changes:
202 str = 'Change log exists, but no version is set'
Paul Burtona920a172016-09-27 16:03:50 +0100203 print(col.Color(col.RED, str))
Simon Glass0d24de92012-01-14 15:12:45 +0000204
Simon Glass983a2742014-09-14 20:23:17 -0600205 def MakeCcFile(self, process_tags, cover_fname, raise_on_error,
Chris Packham4fb35022018-06-07 20:45:06 +1200206 add_maintainers, limit):
Simon Glass0d24de92012-01-14 15:12:45 +0000207 """Make a cc file for us to use for per-commit Cc automation
208
Doug Andersond94566a2012-12-03 14:40:42 +0000209 Also stores in self._generated_cc to make ShowActions() faster.
210
Simon Glass0d24de92012-01-14 15:12:45 +0000211 Args:
212 process_tags: Process tags as if they were aliases
Doug Anderson31187252012-12-03 14:40:43 +0000213 cover_fname: If non-None the name of the cover letter.
Simon Glassa1318f72013-03-26 13:09:42 +0000214 raise_on_error: True to raise an error when an alias fails to match,
215 False to just print a message.
Simon Glass1f487f82017-05-29 15:31:29 -0600216 add_maintainers: Either:
217 True/False to call the get_maintainers to CC maintainers
218 List of maintainers to include (for testing)
Chris Packham4fb35022018-06-07 20:45:06 +1200219 limit: Limit the length of the Cc list
Simon Glass0d24de92012-01-14 15:12:45 +0000220 Return:
221 Filename of temp file created
222 """
Chris Packhame11aa602017-09-01 20:57:53 +1200223 col = terminal.Color()
Simon Glass0d24de92012-01-14 15:12:45 +0000224 # Look for commit tags (of the form 'xxx:' at the start of the subject)
225 fname = '/tmp/patman.%d' % os.getpid()
226 fd = open(fname, 'w')
Doug Anderson31187252012-12-03 14:40:43 +0000227 all_ccs = []
Simon Glass0d24de92012-01-14 15:12:45 +0000228 for commit in self.commits:
Simon Glassa44f4fb2017-05-29 15:31:30 -0600229 cc = []
Simon Glass0d24de92012-01-14 15:12:45 +0000230 if process_tags:
Simon Glassa44f4fb2017-05-29 15:31:30 -0600231 cc += gitutil.BuildEmailList(commit.tags,
Simon Glassa1318f72013-03-26 13:09:42 +0000232 raise_on_error=raise_on_error)
Simon Glassa44f4fb2017-05-29 15:31:30 -0600233 cc += gitutil.BuildEmailList(commit.cc_list,
Simon Glassa1318f72013-03-26 13:09:42 +0000234 raise_on_error=raise_on_error)
Simon Glassa44f4fb2017-05-29 15:31:30 -0600235 if type(add_maintainers) == type(cc):
236 cc += add_maintainers
Simon Glass1f487f82017-05-29 15:31:29 -0600237 elif add_maintainers:
Simon Glassa44f4fb2017-05-29 15:31:30 -0600238 cc += get_maintainer.GetMaintainer(commit.patch)
Chris Packhame11aa602017-09-01 20:57:53 +1200239 for x in set(cc) & set(settings.bounces):
240 print(col.Color(col.YELLOW, 'Skipping "%s"' % x))
241 cc = set(cc) - set(settings.bounces)
Simon Glassf6a6aaf2019-05-14 15:53:54 -0600242 cc = [tools.FromUnicode(m) for m in cc]
Chris Packham4fb35022018-06-07 20:45:06 +1200243 if limit is not None:
244 cc = cc[:limit]
Simon Glassa44f4fb2017-05-29 15:31:30 -0600245 all_ccs += cc
Simon Glassb644c662019-05-14 15:53:51 -0600246 print(commit.patch, ', '.join(sorted(set(cc))), file=fd)
Simon Glassa44f4fb2017-05-29 15:31:30 -0600247 self._generated_cc[commit.patch] = cc
Simon Glass0d24de92012-01-14 15:12:45 +0000248
Doug Anderson31187252012-12-03 14:40:43 +0000249 if cover_fname:
Simon Glassfe2f8d92013-03-20 16:43:00 +0000250 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
Simon Glassf6a6aaf2019-05-14 15:53:54 -0600251 cover_cc = [tools.FromUnicode(m) for m in cover_cc]
Simon Glass513eace2019-05-14 15:53:50 -0600252 cc_list = ', '.join([tools.ToUnicode(x)
Simon Glassb644c662019-05-14 15:53:51 -0600253 for x in sorted(set(cover_cc + all_ccs))])
Chris Packhamf11a0af2017-02-07 20:11:00 +1300254 print(cover_fname, cc_list.encode('utf-8'), file=fd)
Doug Anderson31187252012-12-03 14:40:43 +0000255
Simon Glass0d24de92012-01-14 15:12:45 +0000256 fd.close()
257 return fname
258
259 def AddChange(self, version, commit, info):
260 """Add a new change line to a version.
261
262 This will later appear in the change log.
263
264 Args:
265 version: version number to add change list to
266 info: change line for this version
267 """
268 if not self.changes.get(version):
269 self.changes[version] = []
270 self.changes[version].append([commit, info])
271
272 def GetPatchPrefix(self):
273 """Get the patch version string
274
275 Return:
276 Patch string, like 'RFC PATCH v5' or just 'PATCH'
277 """
Wu, Josh3871cd82015-04-15 10:25:18 +0800278 git_prefix = gitutil.GetDefaultSubjectPrefix()
279 if git_prefix:
Paul Burton12e54762016-09-27 16:03:49 +0100280 git_prefix = '%s][' % git_prefix
Wu, Josh3871cd82015-04-15 10:25:18 +0800281 else:
282 git_prefix = ''
283
Simon Glass0d24de92012-01-14 15:12:45 +0000284 version = ''
285 if self.get('version'):
286 version = ' v%s' % self['version']
287
288 # Get patch name prefix
289 prefix = ''
290 if self.get('prefix'):
291 prefix = '%s ' % self['prefix']
Wu, Josh3871cd82015-04-15 10:25:18 +0800292 return '%s%sPATCH%s' % (git_prefix, prefix, version)