patman: Allow use outside of u-boot tree
[karo-tx-uboot.git] / tools / patman / patman.py
1 #!/usr/bin/python
2 #
3 # Copyright (c) 2011 The Chromium OS Authors.
4 #
5 # See file CREDITS for list of people who contributed to this
6 # project.
7 #
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; either version 2 of
11 # the License, or (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21 # MA 02111-1307 USA
22 #
23
24 """See README for more information"""
25
26 from optparse import OptionParser
27 import os
28 import re
29 import sys
30 import unittest
31
32 # Our modules
33 import checkpatch
34 import command
35 import gitutil
36 import patchstream
37 import project
38 import settings
39 import terminal
40 import test
41
42
43 parser = OptionParser()
44 parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
45        default=False, help='Display the README file')
46 parser.add_option('-c', '--count', dest='count', type='int',
47        default=-1, help='Automatically create patches from top n commits')
48 parser.add_option('-i', '--ignore-errors', action='store_true',
49        dest='ignore_errors', default=False,
50        help='Send patches email even if patch errors are found')
51 parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
52        default=False, help="Do a try run (create but don't email patches)")
53 parser.add_option('-p', '--project', default=project.DetectProject(),
54                   help="Project name; affects default option values and "
55                   "aliases [default: %default]")
56 parser.add_option('-s', '--start', dest='start', type='int',
57        default=0, help='Commit to start creating patches from (0 = HEAD)')
58 parser.add_option('-t', '--test', action='store_true', dest='test',
59                   default=False, help='run tests')
60 parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
61        default=False, help='Verbose output of errors and warnings')
62 parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store',
63        default=None, help='Output cc list for patch file (used by git)')
64 parser.add_option('--no-check', action='store_false', dest='check_patch',
65                   default=True,
66                   help="Don't check for patch compliance")
67 parser.add_option('--no-tags', action='store_false', dest='process_tags',
68                   default=True, help="Don't process subject tags as aliaes")
69
70 parser.usage = """patman [options]
71
72 Create patches from commits in a branch, check them and email them as
73 specified by tags you place in the commits. Use -n to """
74
75
76 # Parse options twice: first to get the project and second to handle
77 # defaults properly (which depends on project).
78 (options, args) = parser.parse_args()
79 settings.Setup(parser, options.project, '')
80 (options, args) = parser.parse_args()
81
82 # Run our meagre tests
83 if options.test:
84     import doctest
85
86     sys.argv = [sys.argv[0]]
87     suite = unittest.TestLoader().loadTestsFromTestCase(test.TestPatch)
88     result = unittest.TestResult()
89     suite.run(result)
90
91     for module in ['gitutil', 'settings']:
92         suite = doctest.DocTestSuite(module)
93         suite.run(result)
94
95     # TODO: Surely we can just 'print' result?
96     print result
97     for test, err in result.errors:
98         print err
99     for test, err in result.failures:
100         print err
101
102 # Called from git with a patch filename as argument
103 # Printout a list of additional CC recipients for this patch
104 elif options.cc_cmd:
105     fd = open(options.cc_cmd, 'r')
106     re_line = re.compile('(\S*) (.*)')
107     for line in fd.readlines():
108         match = re_line.match(line)
109         if match and match.group(1) == args[0]:
110             for cc in match.group(2).split(', '):
111                 cc = cc.strip()
112                 if cc:
113                     print cc
114     fd.close()
115
116 elif options.full_help:
117     pager = os.getenv('PAGER')
118     if not pager:
119         pager = 'more'
120     fname = os.path.join(os.path.dirname(sys.argv[0]), 'README')
121     command.Run(pager, fname)
122
123 # Process commits, produce patches files, check them, email them
124 else:
125     gitutil.Setup()
126
127     if options.count == -1:
128         # Work out how many patches to send if we can
129         options.count = gitutil.CountCommitsToBranch() - options.start
130
131     col = terminal.Color()
132     if not options.count:
133         str = 'No commits found to process - please use -c flag'
134         print col.Color(col.RED, str)
135         sys.exit(1)
136
137     # Read the metadata from the commits
138     if options.count:
139         series = patchstream.GetMetaData(options.start, options.count)
140         cover_fname, args = gitutil.CreatePatches(options.start, options.count,
141                 series)
142
143     # Fix up the patch files to our liking, and insert the cover letter
144     series = patchstream.FixPatches(series, args)
145     if series and cover_fname and series.get('cover'):
146         patchstream.InsertCoverLetter(cover_fname, series, options.count)
147
148     # Do a few checks on the series
149     series.DoChecks()
150
151     # Check the patches, and run them through 'git am' just to be sure
152     if options.check_patch:
153         ok = checkpatch.CheckPatches(options.verbose, args)
154     else:
155         ok = True
156     if not gitutil.ApplyPatches(options.verbose, args,
157             options.count + options.start):
158         ok = False
159
160     cc_file = series.MakeCcFile(options.process_tags, cover_fname)
161
162     # Email the patches out (giving the user time to check / cancel)
163     cmd = ''
164     if ok or options.ignore_errors:
165         cmd = gitutil.EmailPatches(series, cover_fname, args,
166                 options.dry_run, cc_file)
167
168     # For a dry run, just show our actions as a sanity check
169     if options.dry_run:
170         series.ShowActions(args, cmd, options.process_tags)
171
172     os.remove(cc_file)