1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2011 The Chromium OS Authors.
5 from __future__ import print_function
11 from patman import get_maintainer
12 from patman import gitutil
13 from patman import settings
14 from patman import terminal
15 from patman import tools
17 # Series-xxx tags that we understand
18 valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name',
19 'cover_cc', 'process_log']
22 """Holds information about a patch series, including all tags.
25 cc: List of aliases/emails to Cc all patches to
26 commits: List of Commit objects, one for each patch
27 cover: List of lines in the cover letter
28 notes: List of lines in the notes
29 changes: (dict) List of changes for each version, The key is
30 the integer version number
31 allow_overwrite: Allow tags to overwrite an existing tag
41 self.allow_overwrite = False
43 # Written in MakeCcFile()
44 # key: name of patch file
45 # value: list of email addresses
46 self._generated_cc = {}
48 # These make us more like a dictionary
49 def __setattr__(self, name, value):
52 def __getattr__(self, name):
55 def AddTag(self, commit, line, name, value):
56 """Add a new Series-xxx tag along with its value.
59 line: Source line containing tag (useful for debug/error messages)
60 name: Tag name (part after 'Series-')
61 value: Tag value (part after 'Series-xxx: ')
63 # If we already have it, then add to our list
64 name = name.replace('-', '_')
65 if name in self and not self.allow_overwrite:
66 values = value.split(',')
67 values = [str.strip() for str in values]
68 if type(self[name]) != type([]):
69 raise ValueError("In %s: line '%s': Cannot add another value "
70 "'%s' to series '%s'" %
71 (commit.hash, line, values, self[name]))
74 # Otherwise just set the value
75 elif name in valid_series:
81 raise ValueError("In %s: line '%s': Unknown 'Series-%s': valid "
82 "options are %s" % (commit.hash, line, name,
83 ', '.join(valid_series)))
85 def AddCommit(self, commit):
86 """Add a commit into our list of commits
88 We create a list of tags in the commit subject also.
91 commit: Commit object to add
94 self.commits.append(commit)
96 def ShowActions(self, args, cmd, process_tags):
97 """Show what actions we will/would perform
100 args: List of patch files we created
101 cmd: The git command we would have run
102 process_tags: Process tags as if they were aliases
104 to_set = set(gitutil.BuildEmailList(self.to));
105 cc_set = set(gitutil.BuildEmailList(self.cc));
107 col = terminal.Color()
108 print('Dry run, so not doing much. But I would do this:')
110 print('Send a total of %d patch%s with %scover letter.' % (
111 len(args), '' if len(args) == 1 else 'es',
112 self.get('cover') and 'a ' or 'no '))
114 # TODO: Colour the patches according to whether they passed checks
115 for upto in range(len(args)):
116 commit = self.commits[upto]
117 print(col.Color(col.GREEN, ' %s' % args[upto]))
118 cc_list = list(self._generated_cc[commit.patch])
119 for email in sorted(set(cc_list) - to_set - cc_set):
121 email = col.Color(col.YELLOW, "<alias '%s' not found>"
124 print(' Cc: ', email)
126 for item in sorted(to_set):
127 print('To:\t ', item)
128 for item in sorted(cc_set - to_set):
129 print('Cc:\t ', item)
130 print('Version: ', self.get('version'))
131 print('Prefix:\t ', self.get('prefix'))
133 print('Cover: %d lines' % len(self.cover))
134 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
135 all_ccs = itertools.chain(cover_cc, *self._generated_cc.values())
136 for email in sorted(set(all_ccs) - to_set - cc_set):
137 print(' Cc: ', email)
139 print('Git command: %s' % cmd)
141 def MakeChangeLog(self, commit):
142 """Create a list of changes for each version.
145 The change log as a list of strings, one per line
148 - Jog the dial back closer to the widget
154 If there are no new changes in a patch, a note will be added
156 (no changes since v2)
162 # Collect changes from the series and this commit
163 changes = collections.defaultdict(list)
164 for version, changelist in self.changes.items():
165 changes[version] += changelist
167 for version, changelist in commit.changes.items():
168 changes[version] += [[commit, text] for text in changelist]
170 versions = sorted(changes, reverse=True)
172 if 'version' in self:
173 newest_version = max(newest_version, int(self.version))
175 newest_version = max(newest_version, versions[0])
178 process_it = self.get('process_log', '').split(',')
179 process_it = [item.strip() for item in process_it]
181 for version in versions:
183 for this_commit, text in changes[version]:
184 if commit and this_commit != commit:
186 if 'uniq' not in process_it or text not in out:
188 if 'sort' in process_it:
190 have_changes = len(out) > 0
191 line = 'Changes in v%d:' % version
194 if version < newest_version and len(final) == 0:
196 out.insert(0, '(no changes since v%d)' % version)
198 # Only add a new line if we output something
203 need_blank = need_blank or have_changes
207 elif newest_version != 1:
208 final = ['(no changes since v1)', '']
212 """Check that each version has a change log
214 Print an error if something is wrong.
216 col = terminal.Color()
217 if self.get('version'):
218 changes_copy = dict(self.changes)
219 for version in range(1, int(self.version) + 1):
220 if self.changes.get(version):
221 del changes_copy[version]
224 str = 'Change log missing for v%d' % version
225 print(col.Color(col.RED, str))
226 for version in changes_copy:
227 str = 'Change log for unknown version v%d' % version
228 print(col.Color(col.RED, str))
230 str = 'Change log exists, but no version is set'
231 print(col.Color(col.RED, str))
233 def MakeCcFile(self, process_tags, cover_fname, raise_on_error,
234 add_maintainers, limit):
235 """Make a cc file for us to use for per-commit Cc automation
237 Also stores in self._generated_cc to make ShowActions() faster.
240 process_tags: Process tags as if they were aliases
241 cover_fname: If non-None the name of the cover letter.
242 raise_on_error: True to raise an error when an alias fails to match,
243 False to just print a message.
244 add_maintainers: Either:
245 True/False to call the get_maintainers to CC maintainers
246 List of maintainers to include (for testing)
247 limit: Limit the length of the Cc list (None if no limit)
249 Filename of temp file created
251 col = terminal.Color()
252 # Look for commit tags (of the form 'xxx:' at the start of the subject)
253 fname = '/tmp/patman.%d' % os.getpid()
254 fd = open(fname, 'w', encoding='utf-8')
256 for commit in self.commits:
259 cc += gitutil.BuildEmailList(commit.tags,
260 raise_on_error=raise_on_error)
261 cc += gitutil.BuildEmailList(commit.cc_list,
262 raise_on_error=raise_on_error)
263 if type(add_maintainers) == type(cc):
264 cc += add_maintainers
265 elif add_maintainers:
266 dir_list = [os.path.join(gitutil.GetTopLevel(), 'scripts')]
267 cc += get_maintainer.GetMaintainer(dir_list, commit.patch)
268 for x in set(cc) & set(settings.bounces):
269 print(col.Color(col.YELLOW, 'Skipping "%s"' % x))
270 cc = set(cc) - set(settings.bounces)
271 cc = [tools.FromUnicode(m) for m in cc]
272 if limit is not None:
275 print(commit.patch, '\0'.join(sorted(set(cc))), file=fd)
276 self._generated_cc[commit.patch] = cc
279 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
280 cover_cc = [tools.FromUnicode(m) for m in cover_cc]
281 cover_cc = list(set(cover_cc + all_ccs))
282 if limit is not None:
283 cover_cc = cover_cc[:limit]
284 cc_list = '\0'.join([tools.ToUnicode(x) for x in sorted(cover_cc)])
285 print(cover_fname, cc_list, file=fd)
290 def AddChange(self, version, commit, info):
291 """Add a new change line to a version.
293 This will later appear in the change log.
296 version: version number to add change list to
297 info: change line for this version
299 if not self.changes.get(version):
300 self.changes[version] = []
301 self.changes[version].append([commit, info])
303 def GetPatchPrefix(self):
304 """Get the patch version string
307 Patch string, like 'RFC PATCH v5' or just 'PATCH'
309 git_prefix = gitutil.GetDefaultSubjectPrefix()
311 git_prefix = '%s][' % git_prefix
316 if self.get('version'):
317 version = ' v%s' % self['version']
319 # Get patch name prefix
321 if self.get('prefix'):
322 prefix = '%s ' % self['prefix']
323 return '%s%sPATCH%s' % (git_prefix, prefix, version)