blob: 4d7a3044eae8b8d94631aa82f66ea33fa7e7b296 [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
9from optparse import OptionParser
10import 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
Simon Glassbf776672020-04-17 18:09:04 -060021from patman import command
Simon Glassf3653752020-07-05 21:41:49 -060022from patman import control
Simon Glassbf776672020-04-17 18:09:04 -060023from patman import gitutil
Simon Glassbf776672020-04-17 18:09:04 -060024from patman import project
25from patman import settings
26from patman import terminal
Simon Glass2e9a0cd2020-07-05 21:41:48 -060027from patman import test_util
Simon Glass40d97342020-06-14 10:54:04 -060028from patman import test_checkpatch
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')
Simon Glasse9799e02020-07-05 21:41:51 -060034parser.add_option('-b', '--branch', type='str',
35 help="Branch to process (by default, the current branch)")
Simon Glass0d24de92012-01-14 15:12:45 +000036parser.add_option('-c', '--count', dest='count', type='int',
37 default=-1, help='Automatically create patches from top n commits')
Simon Glassd9dc99e2020-07-05 21:41:52 -060038parser.add_option('-e', '--end', type='int', default=0,
39 help='Commits to skip at end of patch list')
Simon Glass0d24de92012-01-14 15:12:45 +000040parser.add_option('-i', '--ignore-errors', action='store_true',
41 dest='ignore_errors', default=False,
42 help='Send patches email even if patch errors are found')
Bin Meng0fc01bf2020-05-04 00:52:43 -070043parser.add_option('-l', '--limit-cc', dest='limit', type='int',
44 default=None, help='Limit the cc list to LIMIT entries [default: %default]')
Simon Glass983a2742014-09-14 20:23:17 -060045parser.add_option('-m', '--no-maintainers', action='store_false',
46 dest='add_maintainers', default=True,
47 help="Don't cc the file maintainers automatically")
Simon Glass0d24de92012-01-14 15:12:45 +000048parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
Simon Glassca706e72013-03-26 13:09:45 +000049 default=False, help="Do a dry run (create but don't email patches)")
Vadim Bendebury99adf6e2013-01-09 16:00:10 +000050parser.add_option('-p', '--project', default=project.DetectProject(),
51 help="Project name; affects default option values and "
52 "aliases [default: %default]")
Doug Anderson6d819922013-03-17 10:31:04 +000053parser.add_option('-r', '--in-reply-to', type='string', action='store',
54 help="Message ID that this series is in reply to")
Simon Glass0d24de92012-01-14 15:12:45 +000055parser.add_option('-s', '--start', dest='start', type='int',
56 default=0, help='Commit to start creating patches from (0 = HEAD)')
Simon Glassa1318f72013-03-26 13:09:42 +000057parser.add_option('-t', '--ignore-bad-tags', action='store_true',
58 default=False, help='Ignore bad tags / aliases')
Simon Glass0d24de92012-01-14 15:12:45 +000059parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
60 default=False, help='Verbose output of errors and warnings')
Bin Meng0fc01bf2020-05-04 00:52:43 -070061parser.add_option('-T', '--thread', action='store_true', dest='thread',
62 default=False, help='Create patches as a single thread')
Simon Glass0d24de92012-01-14 15:12:45 +000063parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store',
64 default=None, help='Output cc list for patch file (used by git)')
Bin Meng14aa35a2020-05-04 00:52:44 -070065parser.add_option('--no-binary', action='store_true', dest='ignore_binary',
66 default=False,
67 help="Do not output contents of changes in binary files")
Vadim Bendebury99adf6e2013-01-09 16:00:10 +000068parser.add_option('--no-check', action='store_false', dest='check_patch',
69 default=True,
70 help="Don't check for patch compliance")
Simon Glass0d24de92012-01-14 15:12:45 +000071parser.add_option('--no-tags', action='store_false', dest='process_tags',
Sean Anderson6949f702020-05-04 16:28:34 -040072 default=True, help="Don't process subject tags as aliases")
Simon Glassa60aedf2018-06-19 09:56:07 -060073parser.add_option('--smtp-server', type='str',
74 help="Specify the SMTP server to 'git send-email'")
Bin Meng0fc01bf2020-05-04 00:52:43 -070075parser.add_option('--test', action='store_true', dest='test',
76 default=False, help='run tests')
Simon Glass0d24de92012-01-14 15:12:45 +000077
Masahiro Yamadae0a4d062014-08-21 14:28:03 +090078parser.usage += """
Simon Glass0d24de92012-01-14 15:12:45 +000079
80Create patches from commits in a branch, check them and email them as
Simon Glassca706e72013-03-26 13:09:45 +000081specified by tags you place in the commits. Use -n to do a dry run first."""
Simon Glass0d24de92012-01-14 15:12:45 +000082
Doug Anderson8568bae2012-12-03 14:43:17 +000083
Doug Andersona1dcee82012-12-03 14:43:18 +000084# Parse options twice: first to get the project and second to handle
85# defaults properly (which depends on project).
86(options, args) = parser.parse_args()
Simon Glassdd3dac22020-06-07 06:45:49 -060087settings.Setup(gitutil, parser, options.project, '')
Simon Glass0d24de92012-01-14 15:12:45 +000088(options, args) = parser.parse_args()
89
Simon Glass9649e152015-07-30 13:47:41 -060090if __name__ != "__main__":
91 pass
92
Simon Glass0d24de92012-01-14 15:12:45 +000093# Run our meagre tests
Simon Glass9649e152015-07-30 13:47:41 -060094elif options.test:
Simon Glass0d24de92012-01-14 15:12:45 +000095 import doctest
Simon Glassbf776672020-04-17 18:09:04 -060096 from patman import func_test
Simon Glass0d24de92012-01-14 15:12:45 +000097
98 sys.argv = [sys.argv[0]]
Simon Glass0d24de92012-01-14 15:12:45 +000099 result = unittest.TestResult()
Simon Glass40d97342020-06-14 10:54:04 -0600100 for module in (test_checkpatch.TestPatch, func_test.TestFunctional):
Simon Glass6e87ae12017-05-29 15:31:31 -0600101 suite = unittest.TestLoader().loadTestsFromTestCase(module)
102 suite.run(result)
Simon Glass0d24de92012-01-14 15:12:45 +0000103
Simon Glass37b224f2020-04-09 15:08:40 -0600104 for module in ['gitutil', 'settings', 'terminal']:
Doug Anderson656cffe2012-12-03 14:43:19 +0000105 suite = doctest.DocTestSuite(module)
106 suite.run(result)
Simon Glass0d24de92012-01-14 15:12:45 +0000107
Simon Glass2e9a0cd2020-07-05 21:41:48 -0600108 sys.exit(test_util.ReportResult('patman', None, result))
Simon Glass0d24de92012-01-14 15:12:45 +0000109
110# Called from git with a patch filename as argument
111# Printout a list of additional CC recipients for this patch
112elif options.cc_cmd:
113 fd = open(options.cc_cmd, 'r')
114 re_line = re.compile('(\S*) (.*)')
115 for line in fd.readlines():
116 match = re_line.match(line)
117 if match and match.group(1) == args[0]:
Dmitry Torokhov8ab452d2019-10-21 20:09:56 -0700118 for cc in match.group(2).split('\0'):
Simon Glass0d24de92012-01-14 15:12:45 +0000119 cc = cc.strip()
120 if cc:
Paul Burtona920a172016-09-27 16:03:50 +0100121 print(cc)
Simon Glass0d24de92012-01-14 15:12:45 +0000122 fd.close()
123
124elif options.full_help:
125 pager = os.getenv('PAGER')
126 if not pager:
127 pager = 'more'
Simon Glass2bdeade2016-03-06 19:45:34 -0700128 fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
129 'README')
Simon Glass0d24de92012-01-14 15:12:45 +0000130 command.Run(pager, fname)
131
132# Process commits, produce patches files, check them, email them
133else:
Simon Glassf3653752020-07-05 21:41:49 -0600134 control.send(options)