blob: 4b3bc787453ec30422adc4372ae2b37f01593a5b [file] [log] [blame]
Michal Simeke8570752013-05-06 04:11:58 +00001#!/usr/bin/env python
Simon Glass0d24de92012-01-14 15:12:45 +00002#
3# Copyright (c) 2011 The Chromium OS Authors.
4#
Wolfgang Denk1a459662013-07-08 09:37:19 +02005# SPDX-License-Identifier: GPL-2.0+
Simon Glass0d24de92012-01-14 15:12:45 +00006#
7
8"""See README for more information"""
9
10from optparse import OptionParser
11import os
12import re
13import sys
14import unittest
15
16# Our modules
Chris Packham488d19c2015-07-22 21:21:46 +120017try:
18 from patman import checkpatch, command, gitutil, patchstream, \
19 project, settings, terminal, test
20except ImportError:
21 import checkpatch
22 import command
23 import gitutil
24 import patchstream
25 import project
26 import settings
27 import terminal
28 import test
Simon Glass0d24de92012-01-14 15:12:45 +000029
30
31parser = OptionParser()
32parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
33 default=False, help='Display the README file')
34parser.add_option('-c', '--count', dest='count', type='int',
35 default=-1, help='Automatically create patches from top n commits')
36parser.add_option('-i', '--ignore-errors', action='store_true',
37 dest='ignore_errors', default=False,
38 help='Send patches email even if patch errors are found')
Simon Glass983a2742014-09-14 20:23:17 -060039parser.add_option('-m', '--no-maintainers', action='store_false',
40 dest='add_maintainers', default=True,
41 help="Don't cc the file maintainers automatically")
Simon Glass0d24de92012-01-14 15:12:45 +000042parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
Simon Glassca706e72013-03-26 13:09:45 +000043 default=False, help="Do a dry run (create but don't email patches)")
Vadim Bendebury99adf6e2013-01-09 16:00:10 +000044parser.add_option('-p', '--project', default=project.DetectProject(),
45 help="Project name; affects default option values and "
46 "aliases [default: %default]")
Doug Anderson6d819922013-03-17 10:31:04 +000047parser.add_option('-r', '--in-reply-to', type='string', action='store',
48 help="Message ID that this series is in reply to")
Simon Glass0d24de92012-01-14 15:12:45 +000049parser.add_option('-s', '--start', dest='start', type='int',
50 default=0, help='Commit to start creating patches from (0 = HEAD)')
Simon Glassa1318f72013-03-26 13:09:42 +000051parser.add_option('-t', '--ignore-bad-tags', action='store_true',
52 default=False, help='Ignore bad tags / aliases')
53parser.add_option('--test', action='store_true', dest='test',
Simon Glass0d24de92012-01-14 15:12:45 +000054 default=False, help='run tests')
55parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
56 default=False, help='Verbose output of errors and warnings')
57parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store',
58 default=None, help='Output cc list for patch file (used by git)')
Vadim Bendebury99adf6e2013-01-09 16:00:10 +000059parser.add_option('--no-check', action='store_false', dest='check_patch',
60 default=True,
61 help="Don't check for patch compliance")
Simon Glass0d24de92012-01-14 15:12:45 +000062parser.add_option('--no-tags', action='store_false', dest='process_tags',
63 default=True, help="Don't process subject tags as aliaes")
Mateusz Kulikowski27067a42016-01-14 20:37:41 +010064parser.add_option('-T', '--thread', action='store_true', dest='thread',
65 default=False, help='Create patches as a single thread')
Simon Glass0d24de92012-01-14 15:12:45 +000066
Masahiro Yamadae0a4d062014-08-21 14:28:03 +090067parser.usage += """
Simon Glass0d24de92012-01-14 15:12:45 +000068
69Create patches from commits in a branch, check them and email them as
Simon Glassca706e72013-03-26 13:09:45 +000070specified by tags you place in the commits. Use -n to do a dry run first."""
Simon Glass0d24de92012-01-14 15:12:45 +000071
Doug Anderson8568bae2012-12-03 14:43:17 +000072
Doug Andersona1dcee82012-12-03 14:43:18 +000073# Parse options twice: first to get the project and second to handle
74# defaults properly (which depends on project).
75(options, args) = parser.parse_args()
76settings.Setup(parser, options.project, '')
Simon Glass0d24de92012-01-14 15:12:45 +000077(options, args) = parser.parse_args()
78
Simon Glass9649e152015-07-30 13:47:41 -060079if __name__ != "__main__":
80 pass
81
Simon Glass0d24de92012-01-14 15:12:45 +000082# Run our meagre tests
Simon Glass9649e152015-07-30 13:47:41 -060083elif options.test:
Simon Glass0d24de92012-01-14 15:12:45 +000084 import doctest
Simon Glass6e87ae12017-05-29 15:31:31 -060085 import func_test
Simon Glass0d24de92012-01-14 15:12:45 +000086
87 sys.argv = [sys.argv[0]]
Simon Glass0d24de92012-01-14 15:12:45 +000088 result = unittest.TestResult()
Simon Glass6e87ae12017-05-29 15:31:31 -060089 for module in (test.TestPatch, func_test.TestFunctional):
90 suite = unittest.TestLoader().loadTestsFromTestCase(module)
91 suite.run(result)
Simon Glass0d24de92012-01-14 15:12:45 +000092
Doug Anderson656cffe2012-12-03 14:43:19 +000093 for module in ['gitutil', 'settings']:
94 suite = doctest.DocTestSuite(module)
95 suite.run(result)
Simon Glass0d24de92012-01-14 15:12:45 +000096
97 # TODO: Surely we can just 'print' result?
Paul Burtona920a172016-09-27 16:03:50 +010098 print(result)
Simon Glass0d24de92012-01-14 15:12:45 +000099 for test, err in result.errors:
Paul Burtona920a172016-09-27 16:03:50 +0100100 print(err)
Simon Glass0d24de92012-01-14 15:12:45 +0000101 for test, err in result.failures:
Paul Burtona920a172016-09-27 16:03:50 +0100102 print(err)
Simon Glass0d24de92012-01-14 15:12:45 +0000103
104# Called from git with a patch filename as argument
105# Printout a list of additional CC recipients for this patch
106elif options.cc_cmd:
107 fd = open(options.cc_cmd, 'r')
108 re_line = re.compile('(\S*) (.*)')
109 for line in fd.readlines():
110 match = re_line.match(line)
111 if match and match.group(1) == args[0]:
112 for cc in match.group(2).split(', '):
113 cc = cc.strip()
114 if cc:
Paul Burtona920a172016-09-27 16:03:50 +0100115 print(cc)
Simon Glass0d24de92012-01-14 15:12:45 +0000116 fd.close()
117
118elif options.full_help:
119 pager = os.getenv('PAGER')
120 if not pager:
121 pager = 'more'
Simon Glass2bdeade2016-03-06 19:45:34 -0700122 fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
123 'README')
Simon Glass0d24de92012-01-14 15:12:45 +0000124 command.Run(pager, fname)
125
126# Process commits, produce patches files, check them, email them
127else:
128 gitutil.Setup()
129
130 if options.count == -1:
131 # Work out how many patches to send if we can
132 options.count = gitutil.CountCommitsToBranch() - options.start
133
134 col = terminal.Color()
135 if not options.count:
136 str = 'No commits found to process - please use -c flag'
Masahiro Yamada31e21412014-08-16 00:59:26 +0900137 sys.exit(col.Color(col.RED, str))
Simon Glass0d24de92012-01-14 15:12:45 +0000138
139 # Read the metadata from the commits
140 if options.count:
141 series = patchstream.GetMetaData(options.start, options.count)
142 cover_fname, args = gitutil.CreatePatches(options.start, options.count,
143 series)
144
145 # Fix up the patch files to our liking, and insert the cover letter
Simon Glassdb116cc2017-05-29 15:31:27 -0600146 patchstream.FixPatches(series, args)
147 if cover_fname and series.get('cover'):
Simon Glass0d24de92012-01-14 15:12:45 +0000148 patchstream.InsertCoverLetter(cover_fname, series, options.count)
149
150 # Do a few checks on the series
151 series.DoChecks()
152
153 # Check the patches, and run them through 'git am' just to be sure
Vadim Bendebury99adf6e2013-01-09 16:00:10 +0000154 if options.check_patch:
155 ok = checkpatch.CheckPatches(options.verbose, args)
156 else:
157 ok = True
Simon Glass0d24de92012-01-14 15:12:45 +0000158
Simon Glassa1318f72013-03-26 13:09:42 +0000159 cc_file = series.MakeCcFile(options.process_tags, cover_fname,
Simon Glass983a2742014-09-14 20:23:17 -0600160 not options.ignore_bad_tags,
161 options.add_maintainers)
Doug Andersond94566a2012-12-03 14:40:42 +0000162
Simon Glass0d24de92012-01-14 15:12:45 +0000163 # Email the patches out (giving the user time to check / cancel)
164 cmd = ''
Vadim Bendebury1f727882014-09-04 10:45:13 -0700165 its_a_go = ok or options.ignore_errors
166 if its_a_go:
Simon Glass0d24de92012-01-14 15:12:45 +0000167 cmd = gitutil.EmailPatches(series, cover_fname, args,
Simon Glassa1318f72013-03-26 13:09:42 +0000168 options.dry_run, not options.ignore_bad_tags, cc_file,
Mateusz Kulikowski27067a42016-01-14 20:37:41 +0100169 in_reply_to=options.in_reply_to, thread=options.thread)
Vadim Bendebury1f727882014-09-04 10:45:13 -0700170 else:
Paul Burtona920a172016-09-27 16:03:50 +0100171 print(col.Color(col.RED, "Not sending emails due to errors/warnings"))
Simon Glass0d24de92012-01-14 15:12:45 +0000172
173 # For a dry run, just show our actions as a sanity check
174 if options.dry_run:
175 series.ShowActions(args, cmd, options.process_tags)
Vadim Bendebury1f727882014-09-04 10:45:13 -0700176 if not its_a_go:
Paul Burtona920a172016-09-27 16:03:50 +0100177 print(col.Color(col.RED, "Email would not be sent"))
Doug Andersond94566a2012-12-03 14:40:42 +0000178
179 os.remove(cc_file)