1 # Copyright (c) 2011 The Chromium OS Authors.
3 # See file CREDITS for list of people who contributed to this
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; either version 2 of
9 # the License, or (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
27 # Series-xxx tags that we understand
28 valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name'];
31 """Holds information about a patch series, including all tags.
34 cc: List of aliases/emails to Cc all patches to
35 commits: List of Commit objects, one for each patch
36 cover: List of lines in the cover letter
37 notes: List of lines in the notes
38 changes: (dict) List of changes for each version, The key is
39 the integer version number
49 # Written in MakeCcFile()
50 # key: name of patch file
51 # value: list of email addresses
52 self._generated_cc = {}
54 # These make us more like a dictionary
55 def __setattr__(self, name, value):
58 def __getattr__(self, name):
61 def AddTag(self, commit, line, name, value):
62 """Add a new Series-xxx tag along with its value.
65 line: Source line containing tag (useful for debug/error messages)
66 name: Tag name (part after 'Series-')
67 value: Tag value (part after 'Series-xxx: ')
69 # If we already have it, then add to our list
71 values = value.split(',')
72 values = [str.strip() for str in values]
73 if type(self[name]) != type([]):
74 raise ValueError("In %s: line '%s': Cannot add another value "
75 "'%s' to series '%s'" %
76 (commit.hash, line, values, self[name]))
79 # Otherwise just set the value
80 elif name in valid_series:
83 raise ValueError("In %s: line '%s': Unknown 'Series-%s': valid "
84 "options are %s" % (commit.hash, line, name,
85 ', '.join(valid_series)))
87 def AddCommit(self, commit):
88 """Add a commit into our list of commits
90 We create a list of tags in the commit subject also.
93 commit: Commit object to add
96 self.commits.append(commit)
98 def ShowActions(self, args, cmd, process_tags):
99 """Show what actions we will/would perform
102 args: List of patch files we created
103 cmd: The git command we would have run
104 process_tags: Process tags as if they were aliases
106 col = terminal.Color()
107 print 'Dry run, so not doing much. But I would do this:'
109 print 'Send a total of %d patch%s with %scover letter.' % (
110 len(args), '' if len(args) == 1 else 'es',
111 self.get('cover') and 'a ' or 'no ')
113 # TODO: Colour the patches according to whether they passed checks
114 for upto in range(len(args)):
115 commit = self.commits[upto]
116 print col.Color(col.GREEN, ' %s' % args[upto])
117 cc_list = list(self._generated_cc[commit.patch])
119 # Skip items in To list
122 map(cc_list.remove, gitutil.BuildEmailList(self.to))
126 for email in cc_list:
128 email = col.Color(col.YELLOW, "<alias '%s' not found>"
133 for item in gitutil.BuildEmailList(self.get('to', '<none>')):
135 for item in gitutil.BuildEmailList(self.cc):
137 print 'Version: ', self.get('version')
138 print 'Prefix:\t ', self.get('prefix')
140 print 'Cover: %d lines' % len(self.cover)
142 print 'Git command: %s' % cmd
144 def MakeChangeLog(self, commit):
145 """Create a list of changes for each version.
148 The change log as a list of strings, one per line
151 - Jog the dial back closer to the widget
162 for change in sorted(self.changes, reverse=True):
164 for this_commit, text in self.changes[change]:
165 if commit and this_commit != commit:
168 line = 'Changes in v%d:' % change
169 have_changes = len(out) > 0
173 out = [line + ' None']
177 need_blank = have_changes
183 """Check that each version has a change log
185 Print an error if something is wrong.
187 col = terminal.Color()
188 if self.get('version'):
189 changes_copy = dict(self.changes)
190 for version in range(1, int(self.version) + 1):
191 if self.changes.get(version):
192 del changes_copy[version]
195 str = 'Change log missing for v%d' % version
196 print col.Color(col.RED, str)
197 for version in changes_copy:
198 str = 'Change log for unknown version v%d' % version
199 print col.Color(col.RED, str)
201 str = 'Change log exists, but no version is set'
202 print col.Color(col.RED, str)
204 def MakeCcFile(self, process_tags):
205 """Make a cc file for us to use for per-commit Cc automation
207 Also stores in self._generated_cc to make ShowActions() faster.
210 process_tags: Process tags as if they were aliases
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')
217 for commit in self.commits:
220 list += gitutil.BuildEmailList(commit.tags)
221 list += gitutil.BuildEmailList(commit.cc_list)
222 print >>fd, commit.patch, ', '.join(list)
223 self._generated_cc[commit.patch] = list
228 def AddChange(self, version, commit, info):
229 """Add a new change line to a version.
231 This will later appear in the change log.
234 version: version number to add change list to
235 info: change line for this version
237 if not self.changes.get(version):
238 self.changes[version] = []
239 self.changes[version].append([commit, info])
241 def GetPatchPrefix(self):
242 """Get the patch version string
245 Patch string, like 'RFC PATCH v5' or just 'PATCH'
248 if self.get('version'):
249 version = ' v%s' % self['version']
251 # Get patch name prefix
253 if self.get('prefix'):
254 prefix = '%s ' % self['prefix']
255 return '%sPATCH%s' % (prefix, version)