blob: 03668d1bb8c4be9988686196060b21ca15ce62ed [file] [log] [blame]
Simon Glasse3986d92019-10-31 07:42:52 -06001#!/usr/bin/env python3
Tom Rini83d290c2018-05-06 17:58:06 -04002# SPDX-License-Identifier: GPL-2.0+
Simon Glass0d24de92012-01-14 15:12:45 +00003#
4# Copyright (c) 2011 The Chromium OS Authors.
5#
Simon Glass0d24de92012-01-14 15:12:45 +00006
7"""See README for more information"""
8
Tom Rini72083962020-07-24 08:42:06 -04009from optparse import OptionParser
Simon Glass0d24de92012-01-14 15:12:45 +000010import os
11import re
12import sys
13import unittest
14
Simon Glass0d7a8c42020-04-17 18:08:52 -060015if __name__ == "__main__":
Simon Glassb4fa9492020-04-17 18:09:05 -060016 # Allow 'from patman import xxx to work'
Simon Glass0d7a8c42020-04-17 18:08:52 -060017 our_path = os.path.dirname(os.path.realpath(__file__))
18 sys.path.append(os.path.join(our_path, '..'))
19
Simon Glass0d24de92012-01-14 15:12:45 +000020# Our modules
Tom Rini72083962020-07-24 08:42:06 -040021from patman import checkpatch
Simon Glassbf776672020-04-17 18:09:04 -060022from patman import command
23from patman import gitutil
Tom Rini72083962020-07-24 08:42:06 -040024from patman import patchstream
Simon Glassbf776672020-04-17 18:09:04 -060025from patman import project
26from patman import settings
27from patman import terminal
Simon Glass0b3d24a2020-07-05 21:41:48 -060028from patman import test_util
Simon Glass40d97342020-06-14 10:54:04 -060029from patman import test_checkpatch
Simon Glass0d24de92012-01-14 15:12:45 +000030
Simon Glass57374b02020-07-05 21:41:55 -060031
Tom Rini72083962020-07-24 08:42:06 -040032parser = OptionParser()
33parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
Simon Glass0d24de92012-01-14 15:12:45 +000034 default=False, help='Display the README file')
Tom Rini72083962020-07-24 08:42:06 -040035parser.add_option('-c', '--count', dest='count', type='int',
36 default=-1, help='Automatically create patches from top n commits')
37parser.add_option('-i', '--ignore-errors', action='store_true',
Simon Glass0d24de92012-01-14 15:12:45 +000038 dest='ignore_errors', default=False,
39 help='Send patches email even if patch errors are found')
Tom Rini72083962020-07-24 08:42:06 -040040parser.add_option('-l', '--limit-cc', dest='limit', type='int',
41 default=None, help='Limit the cc list to LIMIT entries [default: %default]')
42parser.add_option('-m', '--no-maintainers', action='store_false',
Simon Glass983a2742014-09-14 20:23:17 -060043 dest='add_maintainers', default=True,
44 help="Don't cc the file maintainers automatically")
Tom Rini72083962020-07-24 08:42:06 -040045parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
Simon Glassca706e72013-03-26 13:09:45 +000046 default=False, help="Do a dry run (create but don't email patches)")
Tom Rini72083962020-07-24 08:42:06 -040047parser.add_option('-p', '--project', default=project.DetectProject(),
Simon Glass4806fa32020-07-05 21:41:54 -060048 help="Project name; affects default option values and "
Tom Rini72083962020-07-24 08:42:06 -040049 "aliases [default: %default]")
50parser.add_option('-r', '--in-reply-to', type='string', action='store',
Doug Anderson6d819922013-03-17 10:31:04 +000051 help="Message ID that this series is in reply to")
Tom Rini72083962020-07-24 08:42:06 -040052parser.add_option('-s', '--start', dest='start', type='int',
53 default=0, help='Commit to start creating patches from (0 = HEAD)')
54parser.add_option('-t', '--ignore-bad-tags', action='store_true',
Simon Glass4806fa32020-07-05 21:41:54 -060055 default=False, help='Ignore bad tags / aliases')
Tom Rini72083962020-07-24 08:42:06 -040056parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
Simon Glass0d24de92012-01-14 15:12:45 +000057 default=False, help='Verbose output of errors and warnings')
Tom Rini72083962020-07-24 08:42:06 -040058parser.add_option('-T', '--thread', action='store_true', dest='thread',
Simon Glass4806fa32020-07-05 21:41:54 -060059 default=False, help='Create patches as a single thread')
Tom Rini72083962020-07-24 08:42:06 -040060parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store',
Simon Glass0d24de92012-01-14 15:12:45 +000061 default=None, help='Output cc list for patch file (used by git)')
Tom Rini72083962020-07-24 08:42:06 -040062parser.add_option('--no-binary', action='store_true', dest='ignore_binary',
Simon Glass4806fa32020-07-05 21:41:54 -060063 default=False,
64 help="Do not output contents of changes in binary files")
Tom Rini72083962020-07-24 08:42:06 -040065parser.add_option('--no-check', action='store_false', dest='check_patch',
Simon Glass4806fa32020-07-05 21:41:54 -060066 default=True,
67 help="Don't check for patch compliance")
Tom Rini72083962020-07-24 08:42:06 -040068parser.add_option('--no-tags', action='store_false', dest='process_tags',
Simon Glass4806fa32020-07-05 21:41:54 -060069 default=True, help="Don't process subject tags as aliases")
Tom Rini72083962020-07-24 08:42:06 -040070parser.add_option('--smtp-server', type='str',
Simon Glass4806fa32020-07-05 21:41:54 -060071 help="Specify the SMTP server to 'git send-email'")
Tom Rini72083962020-07-24 08:42:06 -040072parser.add_option('--test', action='store_true', dest='test',
73 default=False, help='run tests')
Simon Glass0d24de92012-01-14 15:12:45 +000074
Tom Rini72083962020-07-24 08:42:06 -040075parser.usage += """
Doug Anderson8568bae2012-12-03 14:43:17 +000076
Tom Rini72083962020-07-24 08:42:06 -040077Create patches from commits in a branch, check them and email them as
78specified by tags you place in the commits. Use -n to do a dry run first."""
79
Simon Glass57374b02020-07-05 21:41:55 -060080
Doug Andersona1dcee82012-12-03 14:43:18 +000081# Parse options twice: first to get the project and second to handle
82# defaults properly (which depends on project).
Tom Rini72083962020-07-24 08:42:06 -040083(options, args) = parser.parse_args()
84settings.Setup(gitutil, parser, options.project, '')
85(options, args) = parser.parse_args()
Simon Glass0d24de92012-01-14 15:12:45 +000086
Simon Glass9649e152015-07-30 13:47:41 -060087if __name__ != "__main__":
88 pass
89
Simon Glass0d24de92012-01-14 15:12:45 +000090# Run our meagre tests
Tom Rini72083962020-07-24 08:42:06 -040091elif options.test:
Simon Glass0d24de92012-01-14 15:12:45 +000092 import doctest
Simon Glassbf776672020-04-17 18:09:04 -060093 from patman import func_test
Simon Glass0d24de92012-01-14 15:12:45 +000094
95 sys.argv = [sys.argv[0]]
Simon Glass0d24de92012-01-14 15:12:45 +000096 result = unittest.TestResult()
Simon Glass40d97342020-06-14 10:54:04 -060097 for module in (test_checkpatch.TestPatch, func_test.TestFunctional):
Simon Glass6e87ae12017-05-29 15:31:31 -060098 suite = unittest.TestLoader().loadTestsFromTestCase(module)
99 suite.run(result)
Simon Glass0d24de92012-01-14 15:12:45 +0000100
Simon Glass37b224f2020-04-09 15:08:40 -0600101 for module in ['gitutil', 'settings', 'terminal']:
Doug Anderson656cffe2012-12-03 14:43:19 +0000102 suite = doctest.DocTestSuite(module)
103 suite.run(result)
Simon Glass0d24de92012-01-14 15:12:45 +0000104
Simon Glass0b3d24a2020-07-05 21:41:48 -0600105 sys.exit(test_util.ReportResult('patman', None, result))
Tom Rini72083962020-07-24 08:42:06 -0400106
107# Called from git with a patch filename as argument
108# Printout a list of additional CC recipients for this patch
109elif options.cc_cmd:
110 fd = open(options.cc_cmd, 'r')
111 re_line = re.compile('(\S*) (.*)')
112 for line in fd.readlines():
113 match = re_line.match(line)
114 if match and match.group(1) == args[0]:
115 for cc in match.group(2).split('\0'):
116 cc = cc.strip()
117 if cc:
118 print(cc)
119 fd.close()
120
121elif options.full_help:
122 pager = os.getenv('PAGER')
123 if not pager:
124 pager = 'more'
125 fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
126 'README')
127 command.Run(pager, fname)
Simon Glass0d24de92012-01-14 15:12:45 +0000128
Simon Glass0d24de92012-01-14 15:12:45 +0000129# Process commits, produce patches files, check them, email them
Tom Rini72083962020-07-24 08:42:06 -0400130else:
131 gitutil.Setup()
Simon Glass57374b02020-07-05 21:41:55 -0600132
Tom Rini72083962020-07-24 08:42:06 -0400133 if options.count == -1:
134 # Work out how many patches to send if we can
135 options.count = gitutil.CountCommitsToBranch() - options.start
Simon Glass57374b02020-07-05 21:41:55 -0600136
Tom Rini72083962020-07-24 08:42:06 -0400137 col = terminal.Color()
138 if not options.count:
139 str = 'No commits found to process - please use -c flag'
140 sys.exit(col.Color(col.RED, str))
141
142 # Read the metadata from the commits
143 if options.count:
144 series = patchstream.GetMetaData(options.start, options.count)
145 cover_fname, args = gitutil.CreatePatches(options.start, options.count,
146 options.ignore_binary, series)
147
148 # Fix up the patch files to our liking, and insert the cover letter
149 patchstream.FixPatches(series, args)
150 if cover_fname and series.get('cover'):
151 patchstream.InsertCoverLetter(cover_fname, series, options.count)
152
153 # Do a few checks on the series
154 series.DoChecks()
155
156 # Check the patches, and run them through 'git am' just to be sure
157 if options.check_patch:
158 ok = checkpatch.CheckPatches(options.verbose, args)
Simon Glass57374b02020-07-05 21:41:55 -0600159 else:
Tom Rini72083962020-07-24 08:42:06 -0400160 ok = True
161
162 cc_file = series.MakeCcFile(options.process_tags, cover_fname,
163 not options.ignore_bad_tags,
164 options.add_maintainers, options.limit)
165
166 # Email the patches out (giving the user time to check / cancel)
167 cmd = ''
168 its_a_go = ok or options.ignore_errors
169 if its_a_go:
170 cmd = gitutil.EmailPatches(series, cover_fname, args,
171 options.dry_run, not options.ignore_bad_tags, cc_file,
172 in_reply_to=options.in_reply_to, thread=options.thread,
173 smtp_server=options.smtp_server)
174 else:
175 print(col.Color(col.RED, "Not sending emails due to errors/warnings"))
176
177 # For a dry run, just show our actions as a sanity check
178 if options.dry_run:
179 series.ShowActions(args, cmd, options.process_tags)
180 if not its_a_go:
181 print(col.Color(col.RED, "Email would not be sent"))
182
183 os.remove(cc_file)