1 # Copyright (c) 2011 The Chromium OS Authors.
3 # SPDX-License-Identifier: GPL-2.0+
13 # Series-xxx tags that we understand
14 valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name',
15 'cover_cc', 'process_log']
18 """Holds information about a patch series, including all tags.
21 cc: List of aliases/emails to Cc all patches to
22 commits: List of Commit objects, one for each patch
23 cover: List of lines in the cover letter
24 notes: List of lines in the notes
25 changes: (dict) List of changes for each version, The key is
26 the integer version number
27 allow_overwrite: Allow tags to overwrite an existing tag
37 self.allow_overwrite = False
39 # Written in MakeCcFile()
40 # key: name of patch file
41 # value: list of email addresses
42 self._generated_cc = {}
44 # These make us more like a dictionary
45 def __setattr__(self, name, value):
48 def __getattr__(self, name):
51 def AddTag(self, commit, line, name, value):
52 """Add a new Series-xxx tag along with its value.
55 line: Source line containing tag (useful for debug/error messages)
56 name: Tag name (part after 'Series-')
57 value: Tag value (part after 'Series-xxx: ')
59 # If we already have it, then add to our list
60 name = name.replace('-', '_')
61 if name in self and not self.allow_overwrite:
62 values = value.split(',')
63 values = [str.strip() for str in values]
64 if type(self[name]) != type([]):
65 raise ValueError("In %s: line '%s': Cannot add another value "
66 "'%s' to series '%s'" %
67 (commit.hash, line, values, self[name]))
70 # Otherwise just set the value
71 elif name in valid_series:
74 raise ValueError("In %s: line '%s': Unknown 'Series-%s': valid "
75 "options are %s" % (commit.hash, line, name,
76 ', '.join(valid_series)))
78 def AddCommit(self, commit):
79 """Add a commit into our list of commits
81 We create a list of tags in the commit subject also.
84 commit: Commit object to add
87 self.commits.append(commit)
89 def ShowActions(self, args, cmd, process_tags):
90 """Show what actions we will/would perform
93 args: List of patch files we created
94 cmd: The git command we would have run
95 process_tags: Process tags as if they were aliases
97 to_set = set(gitutil.BuildEmailList(self.to));
98 cc_set = set(gitutil.BuildEmailList(self.cc));
100 col = terminal.Color()
101 print 'Dry run, so not doing much. But I would do this:'
103 print 'Send a total of %d patch%s with %scover letter.' % (
104 len(args), '' if len(args) == 1 else 'es',
105 self.get('cover') and 'a ' or 'no ')
107 # TODO: Colour the patches according to whether they passed checks
108 for upto in range(len(args)):
109 commit = self.commits[upto]
110 print col.Color(col.GREEN, ' %s' % args[upto])
111 cc_list = list(self._generated_cc[commit.patch])
112 for email in set(cc_list) - to_set - cc_set:
114 email = col.Color(col.YELLOW, "<alias '%s' not found>"
121 for item in cc_set - to_set:
123 print 'Version: ', self.get('version')
124 print 'Prefix:\t ', self.get('prefix')
126 print 'Cover: %d lines' % len(self.cover)
127 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
128 all_ccs = itertools.chain(cover_cc, *self._generated_cc.values())
129 for email in set(all_ccs) - to_set - cc_set:
132 print 'Git command: %s' % cmd
134 def MakeChangeLog(self, commit):
135 """Create a list of changes for each version.
138 The change log as a list of strings, one per line
141 - Jog the dial back closer to the widget
151 process_it = self.get('process_log', '').split(',')
152 process_it = [item.strip() for item in process_it]
154 for change in sorted(self.changes, reverse=True):
156 for this_commit, text in self.changes[change]:
157 if commit and this_commit != commit:
159 if 'uniq' not in process_it or text not in out:
161 line = 'Changes in v%d:' % change
162 have_changes = len(out) > 0
163 if 'sort' in process_it:
168 out = [line + ' None']
172 need_blank = have_changes
178 """Check that each version has a change log
180 Print an error if something is wrong.
182 col = terminal.Color()
183 if self.get('version'):
184 changes_copy = dict(self.changes)
185 for version in range(1, int(self.version) + 1):
186 if self.changes.get(version):
187 del changes_copy[version]
190 str = 'Change log missing for v%d' % version
191 print col.Color(col.RED, str)
192 for version in changes_copy:
193 str = 'Change log for unknown version v%d' % version
194 print col.Color(col.RED, str)
196 str = 'Change log exists, but no version is set'
197 print col.Color(col.RED, str)
199 def MakeCcFile(self, process_tags, cover_fname, raise_on_error,
201 """Make a cc file for us to use for per-commit Cc automation
203 Also stores in self._generated_cc to make ShowActions() faster.
206 process_tags: Process tags as if they were aliases
207 cover_fname: If non-None the name of the cover letter.
208 raise_on_error: True to raise an error when an alias fails to match,
209 False to just print a message.
210 add_maintainers: Call the get_maintainers to CC maintainers
212 Filename of temp file created
214 # Look for commit tags (of the form 'xxx:' at the start of the subject)
215 fname = '/tmp/patman.%d' % os.getpid()
216 fd = open(fname, 'w')
218 for commit in self.commits:
221 list += gitutil.BuildEmailList(commit.tags,
222 raise_on_error=raise_on_error)
223 list += gitutil.BuildEmailList(commit.cc_list,
224 raise_on_error=raise_on_error)
226 list += get_maintainer.GetMaintainer(commit.patch)
228 print >>fd, commit.patch, ', '.join(set(list))
229 self._generated_cc[commit.patch] = list
232 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', ''))
233 print >>fd, cover_fname, ', '.join(set(cover_cc + all_ccs))
238 def AddChange(self, version, commit, info):
239 """Add a new change line to a version.
241 This will later appear in the change log.
244 version: version number to add change list to
245 info: change line for this version
247 if not self.changes.get(version):
248 self.changes[version] = []
249 self.changes[version].append([commit, info])
251 def GetPatchPrefix(self):
252 """Get the patch version string
255 Patch string, like 'RFC PATCH v5' or just 'PATCH'
257 git_prefix = gitutil.GetDefaultSubjectPrefix()
259 git_prefix = '%s][' % git_prefix
264 if self.get('version'):
265 version = ' v%s' % self['version']
267 # Get patch name prefix
269 if self.get('prefix'):
270 prefix = '%s ' % self['prefix']
271 return '%s%sPATCH%s' % (git_prefix, prefix, version)