]>
Commit | Line | Data |
---|---|---|
0d24de9d SG |
1 | # Copyright (c) 2011 The Chromium OS Authors. |
2 | # | |
1a459660 | 3 | # SPDX-License-Identifier: GPL-2.0+ |
0d24de9d SG |
4 | # |
5 | ||
31187255 | 6 | import itertools |
0d24de9d SG |
7 | import os |
8 | ||
21a19d70 | 9 | import get_maintainer |
0d24de9d SG |
10 | import gitutil |
11 | import terminal | |
12 | ||
13 | # Series-xxx tags that we understand | |
fe2f8d9e | 14 | valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name', |
645b271a | 15 | 'cover-cc', 'process_log'] |
0d24de9d SG |
16 | |
17 | class Series(dict): | |
18 | """Holds information about a patch series, including all tags. | |
19 | ||
20 | Vars: | |
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 | |
f0b739f1 | 27 | allow_overwrite: Allow tags to overwrite an existing tag |
0d24de9d SG |
28 | """ |
29 | def __init__(self): | |
30 | self.cc = [] | |
31 | self.to = [] | |
fe2f8d9e | 32 | self.cover_cc = [] |
0d24de9d SG |
33 | self.commits = [] |
34 | self.cover = None | |
35 | self.notes = [] | |
36 | self.changes = {} | |
f0b739f1 | 37 | self.allow_overwrite = False |
0d24de9d | 38 | |
d94566a1 DA |
39 | # Written in MakeCcFile() |
40 | # key: name of patch file | |
41 | # value: list of email addresses | |
42 | self._generated_cc = {} | |
43 | ||
0d24de9d SG |
44 | # These make us more like a dictionary |
45 | def __setattr__(self, name, value): | |
46 | self[name] = value | |
47 | ||
48 | def __getattr__(self, name): | |
49 | return self[name] | |
50 | ||
51 | def AddTag(self, commit, line, name, value): | |
52 | """Add a new Series-xxx tag along with its value. | |
53 | ||
54 | Args: | |
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: ') | |
58 | """ | |
59 | # If we already have it, then add to our list | |
fe2f8d9e | 60 | name = name.replace('-', '_') |
f0b739f1 | 61 | if name in self and not self.allow_overwrite: |
0d24de9d SG |
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])) | |
68 | self[name] += values | |
69 | ||
70 | # Otherwise just set the value | |
71 | elif name in valid_series: | |
72 | self[name] = value | |
73 | else: | |
74 | raise ValueError("In %s: line '%s': Unknown 'Series-%s': valid " | |
ef0e9de8 | 75 | "options are %s" % (commit.hash, line, name, |
0d24de9d SG |
76 | ', '.join(valid_series))) |
77 | ||
78 | def AddCommit(self, commit): | |
79 | """Add a commit into our list of commits | |
80 | ||
81 | We create a list of tags in the commit subject also. | |
82 | ||
83 | Args: | |
84 | commit: Commit object to add | |
85 | """ | |
86 | commit.CheckTags() | |
87 | self.commits.append(commit) | |
88 | ||
89 | def ShowActions(self, args, cmd, process_tags): | |
90 | """Show what actions we will/would perform | |
91 | ||
92 | Args: | |
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 | |
96 | """ | |
2181830f PT |
97 | to_set = set(gitutil.BuildEmailList(self.to)); |
98 | cc_set = set(gitutil.BuildEmailList(self.cc)); | |
99 | ||
0d24de9d SG |
100 | col = terminal.Color() |
101 | print 'Dry run, so not doing much. But I would do this:' | |
102 | ||
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 ') | |
106 | ||
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]) | |
d94566a1 | 111 | cc_list = list(self._generated_cc[commit.patch]) |
2181830f | 112 | for email in set(cc_list) - to_set - cc_set: |
0d24de9d SG |
113 | if email == None: |
114 | email = col.Color(col.YELLOW, "<alias '%s' not found>" | |
115 | % tag) | |
116 | if email: | |
117 | print ' Cc: ',email | |
118 | ||
2181830f | 119 | for item in to_set: |
0d24de9d | 120 | print 'To:\t ', item |
2181830f | 121 | for item in cc_set - to_set: |
0d24de9d SG |
122 | print 'Cc:\t ', item |
123 | print 'Version: ', self.get('version') | |
124 | print 'Prefix:\t ', self.get('prefix') | |
125 | if self.cover: | |
126 | print 'Cover: %d lines' % len(self.cover) | |
fe2f8d9e SG |
127 | cover_cc = gitutil.BuildEmailList(self.get('cover_cc', '')) |
128 | all_ccs = itertools.chain(cover_cc, *self._generated_cc.values()) | |
2181830f | 129 | for email in set(all_ccs) - to_set - cc_set: |
31187255 | 130 | print ' Cc: ',email |
0d24de9d SG |
131 | if cmd: |
132 | print 'Git command: %s' % cmd | |
133 | ||
134 | def MakeChangeLog(self, commit): | |
135 | """Create a list of changes for each version. | |
136 | ||
137 | Return: | |
138 | The change log as a list of strings, one per line | |
139 | ||
27e97600 | 140 | Changes in v4: |
244e6f97 OS |
141 | - Jog the dial back closer to the widget |
142 | ||
27e97600 SG |
143 | Changes in v3: None |
144 | Changes in v2: | |
0d24de9d SG |
145 | - Fix the widget |
146 | - Jog the dial | |
147 | ||
0d24de9d SG |
148 | etc. |
149 | """ | |
150 | final = [] | |
645b271a SG |
151 | process_it = self.get('process_log', '').split(',') |
152 | process_it = [item.strip() for item in process_it] | |
0d24de9d | 153 | need_blank = False |
244e6f97 | 154 | for change in sorted(self.changes, reverse=True): |
0d24de9d SG |
155 | out = [] |
156 | for this_commit, text in self.changes[change]: | |
157 | if commit and this_commit != commit: | |
158 | continue | |
645b271a SG |
159 | if 'uniq' not in process_it or text not in out: |
160 | out.append(text) | |
27e97600 SG |
161 | line = 'Changes in v%d:' % change |
162 | have_changes = len(out) > 0 | |
645b271a SG |
163 | if 'sort' in process_it: |
164 | out = sorted(out) | |
27e97600 SG |
165 | if have_changes: |
166 | out.insert(0, line) | |
167 | else: | |
168 | out = [line + ' None'] | |
169 | if need_blank: | |
170 | out.insert(0, '') | |
171 | final += out | |
172 | need_blank = have_changes | |
0d24de9d SG |
173 | if self.changes: |
174 | final.append('') | |
175 | return final | |
176 | ||
177 | def DoChecks(self): | |
178 | """Check that each version has a change log | |
179 | ||
180 | Print an error if something is wrong. | |
181 | """ | |
182 | col = terminal.Color() | |
183 | if self.get('version'): | |
184 | changes_copy = dict(self.changes) | |
d5f81d8a | 185 | for version in range(1, int(self.version) + 1): |
0d24de9d SG |
186 | if self.changes.get(version): |
187 | del changes_copy[version] | |
188 | else: | |
d5f81d8a OS |
189 | if version > 1: |
190 | str = 'Change log missing for v%d' % version | |
191 | print col.Color(col.RED, str) | |
0d24de9d SG |
192 | for version in changes_copy: |
193 | str = 'Change log for unknown version v%d' % version | |
194 | print col.Color(col.RED, str) | |
195 | elif self.changes: | |
196 | str = 'Change log exists, but no version is set' | |
197 | print col.Color(col.RED, str) | |
198 | ||
983a2749 SG |
199 | def MakeCcFile(self, process_tags, cover_fname, raise_on_error, |
200 | add_maintainers): | |
0d24de9d SG |
201 | """Make a cc file for us to use for per-commit Cc automation |
202 | ||
d94566a1 DA |
203 | Also stores in self._generated_cc to make ShowActions() faster. |
204 | ||
0d24de9d SG |
205 | Args: |
206 | process_tags: Process tags as if they were aliases | |
31187255 | 207 | cover_fname: If non-None the name of the cover letter. |
a1318f7c SG |
208 | raise_on_error: True to raise an error when an alias fails to match, |
209 | False to just print a message. | |
983a2749 | 210 | add_maintainers: Call the get_maintainers to CC maintainers |
0d24de9d SG |
211 | Return: |
212 | Filename of temp file created | |
213 | """ | |
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') | |
31187255 | 217 | all_ccs = [] |
0d24de9d SG |
218 | for commit in self.commits: |
219 | list = [] | |
220 | if process_tags: | |
a1318f7c SG |
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) | |
983a2749 SG |
225 | if add_maintainers: |
226 | list += get_maintainer.GetMaintainer(commit.patch) | |
31187255 | 227 | all_ccs += list |
2181830f | 228 | print >>fd, commit.patch, ', '.join(set(list)) |
d94566a1 | 229 | self._generated_cc[commit.patch] = list |
0d24de9d | 230 | |
31187255 | 231 | if cover_fname: |
fe2f8d9e SG |
232 | cover_cc = gitutil.BuildEmailList(self.get('cover_cc', '')) |
233 | print >>fd, cover_fname, ', '.join(set(cover_cc + all_ccs)) | |
31187255 | 234 | |
0d24de9d SG |
235 | fd.close() |
236 | return fname | |
237 | ||
238 | def AddChange(self, version, commit, info): | |
239 | """Add a new change line to a version. | |
240 | ||
241 | This will later appear in the change log. | |
242 | ||
243 | Args: | |
244 | version: version number to add change list to | |
245 | info: change line for this version | |
246 | """ | |
247 | if not self.changes.get(version): | |
248 | self.changes[version] = [] | |
249 | self.changes[version].append([commit, info]) | |
250 | ||
251 | def GetPatchPrefix(self): | |
252 | """Get the patch version string | |
253 | ||
254 | Return: | |
255 | Patch string, like 'RFC PATCH v5' or just 'PATCH' | |
256 | """ | |
3871cd85 WJ |
257 | git_prefix = gitutil.GetDefaultSubjectPrefix() |
258 | if git_prefix: | |
259 | git_prefix = '%s][' % git_prefix | |
260 | else: | |
261 | git_prefix = '' | |
262 | ||
0d24de9d SG |
263 | version = '' |
264 | if self.get('version'): | |
265 | version = ' v%s' % self['version'] | |
266 | ||
267 | # Get patch name prefix | |
268 | prefix = '' | |
269 | if self.get('prefix'): | |
270 | prefix = '%s ' % self['prefix'] | |
3871cd85 | 271 | return '%s%sPATCH%s' % (git_prefix, prefix, version) |