blob: d3947a7c2ac5ce7ac09793777ccea681f84c88a6 [file] [log] [blame]
Simon Glass26132882012-01-14 15:12:45 +00001# Copyright (c) 2011 The Chromium OS Authors.
2#
Wolfgang Denkd79de1d2013-07-08 09:37:19 +02003# SPDX-License-Identifier: GPL-2.0+
Simon Glass26132882012-01-14 15:12:45 +00004#
5
Paul Burtonc3931342016-09-27 16:03:50 +01006from __future__ import print_function
7
Doug Anderson05416af2012-12-03 14:40:43 +00008import itertools
Simon Glass26132882012-01-14 15:12:45 +00009import os
10
Doug Andersonc2c84bc2012-12-03 14:43:16 +000011import get_maintainer
Simon Glass26132882012-01-14 15:12:45 +000012import gitutil
13import terminal
14
15# Series-xxx tags that we understand
Simon Glassc72f3da2013-03-20 16:43:00 +000016valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name',
Simon Glass420d4ee2015-08-22 18:28:01 -060017 'cover_cc', 'process_log']
Simon Glass26132882012-01-14 15:12:45 +000018
19class Series(dict):
20 """Holds information about a patch series, including all tags.
21
22 Vars:
23 cc: List of aliases/emails to Cc all patches to
24 commits: List of Commit objects, one for each patch
25 cover: List of lines in the cover letter
26 notes: List of lines in the notes
27 changes: (dict) List of changes for each version, The key is
28 the integer version number
Simon Glass29c5abc2013-05-02 14:46:02 +000029 allow_overwrite: Allow tags to overwrite an existing tag
Simon Glass26132882012-01-14 15:12:45 +000030 """
31 def __init__(self):
32 self.cc = []
33 self.to = []
Simon Glassc72f3da2013-03-20 16:43:00 +000034 self.cover_cc = []
Simon Glass26132882012-01-14 15:12:45 +000035 self.commits = []
36 self.cover = None
37 self.notes = []
38 self.changes = {}
Simon Glass29c5abc2013-05-02 14:46:02 +000039 self.allow_overwrite = False
Simon Glass26132882012-01-14 15:12:45 +000040
Doug Anderson507e8e82012-12-03 14:40:42 +000041 # Written in MakeCcFile()
42 # key: name of patch file
43 # value: list of email addresses
44 self._generated_cc = {}
45
Simon Glass26132882012-01-14 15:12:45 +000046 # These make us more like a dictionary
47 def __setattr__(self, name, value):
48 self[name] = value
49
50 def __getattr__(self, name):
51 return self[name]
52
53 def AddTag(self, commit, line, name, value):
54 """Add a new Series-xxx tag along with its value.
55
56 Args:
57 line: Source line containing tag (useful for debug/error messages)
58 name: Tag name (part after 'Series-')
59 value: Tag value (part after 'Series-xxx: ')
60 """
61 # If we already have it, then add to our list
Simon Glassc72f3da2013-03-20 16:43:00 +000062 name = name.replace('-', '_')
Simon Glass29c5abc2013-05-02 14:46:02 +000063 if name in self and not self.allow_overwrite:
Simon Glass26132882012-01-14 15:12:45 +000064 values = value.split(',')
65 values = [str.strip() for str in values]
66 if type(self[name]) != type([]):
67 raise ValueError("In %s: line '%s': Cannot add another value "
68 "'%s' to series '%s'" %
69 (commit.hash, line, values, self[name]))
70 self[name] += values
71
72 # Otherwise just set the value
73 elif name in valid_series:
Albert ARIBAUD77ec8bc2016-02-02 10:24:53 +010074 if name=="notes":
75 self[name] = [value]
76 else:
77 self[name] = value
Simon Glass26132882012-01-14 15:12:45 +000078 else:
79 raise ValueError("In %s: line '%s': Unknown 'Series-%s': valid "
Simon Glasse7ecd3f2012-09-27 15:06:02 +000080 "options are %s" % (commit.hash, line, name,
Simon Glass26132882012-01-14 15:12:45 +000081 ', '.join(valid_series)))
82
83 def AddCommit(self, commit):
84 """Add a commit into our list of commits
85
86 We create a list of tags in the commit subject also.
87
88 Args:
89 commit: Commit object to add
90 """
91 commit.CheckTags()
92 self.commits.append(commit)
93
94 def ShowActions(self, args, cmd, process_tags):
95 """Show what actions we will/would perform
96
97 Args:
98 args: List of patch files we created
99 cmd: The git command we would have run
100 process_tags: Process tags as if they were aliases
101 """
Peter Tyserc6af8022015-01-26 11:42:21 -0600102 to_set = set(gitutil.BuildEmailList(self.to));
103 cc_set = set(gitutil.BuildEmailList(self.cc));
104
Simon Glass26132882012-01-14 15:12:45 +0000105 col = terminal.Color()
Paul Burtonc3931342016-09-27 16:03:50 +0100106 print('Dry run, so not doing much. But I would do this:')
107 print()
108 print('Send a total of %d patch%s with %scover letter.' % (
Simon Glass26132882012-01-14 15:12:45 +0000109 len(args), '' if len(args) == 1 else 'es',
Paul Burtonc3931342016-09-27 16:03:50 +0100110 self.get('cover') and 'a ' or 'no '))
Simon Glass26132882012-01-14 15:12:45 +0000111
112 # TODO: Colour the patches according to whether they passed checks
113 for upto in range(len(args)):
114 commit = self.commits[upto]
Paul Burtonc3931342016-09-27 16:03:50 +0100115 print(col.Color(col.GREEN, ' %s' % args[upto]))
Doug Anderson507e8e82012-12-03 14:40:42 +0000116 cc_list = list(self._generated_cc[commit.patch])
Peter Tyserc6af8022015-01-26 11:42:21 -0600117 for email in set(cc_list) - to_set - cc_set:
Simon Glass26132882012-01-14 15:12:45 +0000118 if email == None:
119 email = col.Color(col.YELLOW, "<alias '%s' not found>"
120 % tag)
121 if email:
Simon Glass22c58342017-05-29 15:31:23 -0600122 print(' Cc: ', email)
Simon Glass26132882012-01-14 15:12:45 +0000123 print
Peter Tyserc6af8022015-01-26 11:42:21 -0600124 for item in to_set:
Paul Burtonc3931342016-09-27 16:03:50 +0100125 print('To:\t ', item)
Peter Tyserc6af8022015-01-26 11:42:21 -0600126 for item in cc_set - to_set:
Paul Burtonc3931342016-09-27 16:03:50 +0100127 print('Cc:\t ', item)
128 print('Version: ', self.get('version'))
129 print('Prefix:\t ', self.get('prefix'))
Simon Glass26132882012-01-14 15:12:45 +0000130 if self.cover:
Paul Burtonc3931342016-09-27 16:03:50 +0100131 print('Cover: %d lines' % len(self.cover))
Simon Glassc72f3da2013-03-20 16:43:00 +0000132 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
133 all_ccs = itertools.chain(cover_cc, *self._generated_cc.values())
Peter Tyserc6af8022015-01-26 11:42:21 -0600134 for email in set(all_ccs) - to_set - cc_set:
Paul Burtonc3931342016-09-27 16:03:50 +0100135 print(' Cc: ', email)
Simon Glass26132882012-01-14 15:12:45 +0000136 if cmd:
Paul Burtonc3931342016-09-27 16:03:50 +0100137 print('Git command: %s' % cmd)
Simon Glass26132882012-01-14 15:12:45 +0000138
139 def MakeChangeLog(self, commit):
140 """Create a list of changes for each version.
141
142 Return:
143 The change log as a list of strings, one per line
144
Simon Glassaa912af2012-10-30 06:15:16 +0000145 Changes in v4:
Otavio Salvadorcc1fbaa2012-08-18 07:46:04 +0000146 - Jog the dial back closer to the widget
147
Simon Glassaa912af2012-10-30 06:15:16 +0000148 Changes in v3: None
149 Changes in v2:
Simon Glass26132882012-01-14 15:12:45 +0000150 - Fix the widget
151 - Jog the dial
152
Simon Glass26132882012-01-14 15:12:45 +0000153 etc.
154 """
155 final = []
Simon Glassec1d0422013-03-26 13:09:44 +0000156 process_it = self.get('process_log', '').split(',')
157 process_it = [item.strip() for item in process_it]
Simon Glass26132882012-01-14 15:12:45 +0000158 need_blank = False
Otavio Salvadorcc1fbaa2012-08-18 07:46:04 +0000159 for change in sorted(self.changes, reverse=True):
Simon Glass26132882012-01-14 15:12:45 +0000160 out = []
161 for this_commit, text in self.changes[change]:
162 if commit and this_commit != commit:
163 continue
Simon Glassec1d0422013-03-26 13:09:44 +0000164 if 'uniq' not in process_it or text not in out:
165 out.append(text)
Simon Glassaa912af2012-10-30 06:15:16 +0000166 line = 'Changes in v%d:' % change
167 have_changes = len(out) > 0
Simon Glassec1d0422013-03-26 13:09:44 +0000168 if 'sort' in process_it:
169 out = sorted(out)
Simon Glassaa912af2012-10-30 06:15:16 +0000170 if have_changes:
171 out.insert(0, line)
172 else:
173 out = [line + ' None']
174 if need_blank:
175 out.insert(0, '')
176 final += out
177 need_blank = have_changes
Simon Glass26132882012-01-14 15:12:45 +0000178 if self.changes:
179 final.append('')
180 return final
181
182 def DoChecks(self):
183 """Check that each version has a change log
184
185 Print an error if something is wrong.
186 """
187 col = terminal.Color()
188 if self.get('version'):
189 changes_copy = dict(self.changes)
Otavio Salvadorfe07d072012-08-13 10:08:22 +0000190 for version in range(1, int(self.version) + 1):
Simon Glass26132882012-01-14 15:12:45 +0000191 if self.changes.get(version):
192 del changes_copy[version]
193 else:
Otavio Salvadorfe07d072012-08-13 10:08:22 +0000194 if version > 1:
195 str = 'Change log missing for v%d' % version
Paul Burtonc3931342016-09-27 16:03:50 +0100196 print(col.Color(col.RED, str))
Simon Glass26132882012-01-14 15:12:45 +0000197 for version in changes_copy:
198 str = 'Change log for unknown version v%d' % version
Paul Burtonc3931342016-09-27 16:03:50 +0100199 print(col.Color(col.RED, str))
Simon Glass26132882012-01-14 15:12:45 +0000200 elif self.changes:
201 str = 'Change log exists, but no version is set'
Paul Burtonc3931342016-09-27 16:03:50 +0100202 print(col.Color(col.RED, str))
Simon Glass26132882012-01-14 15:12:45 +0000203
Simon Glass46b84d82014-09-14 20:23:17 -0600204 def MakeCcFile(self, process_tags, cover_fname, raise_on_error,
205 add_maintainers):
Simon Glass26132882012-01-14 15:12:45 +0000206 """Make a cc file for us to use for per-commit Cc automation
207
Doug Anderson507e8e82012-12-03 14:40:42 +0000208 Also stores in self._generated_cc to make ShowActions() faster.
209
Simon Glass26132882012-01-14 15:12:45 +0000210 Args:
211 process_tags: Process tags as if they were aliases
Doug Anderson05416af2012-12-03 14:40:43 +0000212 cover_fname: If non-None the name of the cover letter.
Simon Glass12ea5f42013-03-26 13:09:42 +0000213 raise_on_error: True to raise an error when an alias fails to match,
214 False to just print a message.
Simon Glassb712eed2017-05-29 15:31:29 -0600215 add_maintainers: Either:
216 True/False to call the get_maintainers to CC maintainers
217 List of maintainers to include (for testing)
Simon Glass26132882012-01-14 15:12:45 +0000218 Return:
219 Filename of temp file created
220 """
221 # Look for commit tags (of the form 'xxx:' at the start of the subject)
222 fname = '/tmp/patman.%d' % os.getpid()
223 fd = open(fname, 'w')
Doug Anderson05416af2012-12-03 14:40:43 +0000224 all_ccs = []
Simon Glass26132882012-01-14 15:12:45 +0000225 for commit in self.commits:
Simon Glass0f94fa72017-05-29 15:31:30 -0600226 cc = []
Simon Glass26132882012-01-14 15:12:45 +0000227 if process_tags:
Simon Glass0f94fa72017-05-29 15:31:30 -0600228 cc += gitutil.BuildEmailList(commit.tags,
Simon Glass12ea5f42013-03-26 13:09:42 +0000229 raise_on_error=raise_on_error)
Simon Glass0f94fa72017-05-29 15:31:30 -0600230 cc += gitutil.BuildEmailList(commit.cc_list,
Simon Glass12ea5f42013-03-26 13:09:42 +0000231 raise_on_error=raise_on_error)
Simon Glass0f94fa72017-05-29 15:31:30 -0600232 if type(add_maintainers) == type(cc):
233 cc += add_maintainers
Simon Glassb712eed2017-05-29 15:31:29 -0600234 elif add_maintainers:
Simon Glass0f94fa72017-05-29 15:31:30 -0600235 cc += get_maintainer.GetMaintainer(commit.patch)
236 cc = [m.encode('utf-8') if type(m) != str else m for m in cc]
237 all_ccs += cc
238 print(commit.patch, ', '.join(set(cc)), file=fd)
239 self._generated_cc[commit.patch] = cc
Simon Glass26132882012-01-14 15:12:45 +0000240
Doug Anderson05416af2012-12-03 14:40:43 +0000241 if cover_fname:
Simon Glassc72f3da2013-03-20 16:43:00 +0000242 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
Simon Glass22c58342017-05-29 15:31:23 -0600243 cover_cc = [m.encode('utf-8') if type(m) != str else m
244 for m in cover_cc]
245 cc_list = ', '.join([x.decode('utf-8')
246 for x in set(cover_cc + all_ccs)])
Chris Packhamcb17cae2017-02-07 20:11:00 +1300247 print(cover_fname, cc_list.encode('utf-8'), file=fd)
Doug Anderson05416af2012-12-03 14:40:43 +0000248
Simon Glass26132882012-01-14 15:12:45 +0000249 fd.close()
250 return fname
251
252 def AddChange(self, version, commit, info):
253 """Add a new change line to a version.
254
255 This will later appear in the change log.
256
257 Args:
258 version: version number to add change list to
259 info: change line for this version
260 """
261 if not self.changes.get(version):
262 self.changes[version] = []
263 self.changes[version].append([commit, info])
264
265 def GetPatchPrefix(self):
266 """Get the patch version string
267
268 Return:
269 Patch string, like 'RFC PATCH v5' or just 'PATCH'
270 """
Wu, Josh9873b912015-04-15 10:25:18 +0800271 git_prefix = gitutil.GetDefaultSubjectPrefix()
272 if git_prefix:
Paul Burtona5edb442016-09-27 16:03:49 +0100273 git_prefix = '%s][' % git_prefix
Wu, Josh9873b912015-04-15 10:25:18 +0800274 else:
275 git_prefix = ''
276
Simon Glass26132882012-01-14 15:12:45 +0000277 version = ''
278 if self.get('version'):
279 version = ' v%s' % self['version']
280
281 # Get patch name prefix
282 prefix = ''
283 if self.get('prefix'):
284 prefix = '%s ' % self['prefix']
Wu, Josh9873b912015-04-15 10:25:18 +0800285 return '%s%sPATCH%s' % (git_prefix, prefix, version)