blob: 197ac1aad1033bcce76b80c6355a5f26e6d2022c [file] [log] [blame]
Simon Glassefeac062019-10-31 07:42:52 -06001#!/usr/bin/env python3
Tom Rini10e47792018-05-06 17:58:06 -04002# SPDX-License-Identifier: GPL-2.0+
Simon Glass26132882012-01-14 15:12:45 +00003#
4# Copyright (c) 2011 The Chromium OS Authors.
5#
Simon Glass26132882012-01-14 15:12:45 +00006
7"""See README for more information"""
8
Simon Glasseb101ac2020-07-05 21:41:53 -06009from argparse import ArgumentParser
Jan Kiszka6d7c40c2023-04-22 16:42:48 +020010try:
11 import importlib.resources
12except ImportError:
13 # for Python 3.6
14 import importlib_resources
Simon Glass26132882012-01-14 15:12:45 +000015import os
16import re
17import sys
Simon Glassdbac7162020-07-05 21:41:59 -060018import traceback
Simon Glass26132882012-01-14 15:12:45 +000019
Simon Glassbdaad402020-04-17 18:08:52 -060020if __name__ == "__main__":
Simon Glass42143162020-04-17 18:09:05 -060021 # Allow 'from patman import xxx to work'
Simon Glassbdaad402020-04-17 18:08:52 -060022 our_path = os.path.dirname(os.path.realpath(__file__))
23 sys.path.append(os.path.join(our_path, '..'))
24
Simon Glass26132882012-01-14 15:12:45 +000025# Our modules
Simon Glass24725af2020-07-05 21:41:49 -060026from patman import control
Maxim Cournoyercda00122022-12-19 17:32:43 -050027from patman import func_test
Maxim Cournoyer3ef23e92022-12-20 00:28:46 -050028from patman import gitutil
Simon Glassa997ea52020-04-17 18:09:04 -060029from patman import project
30from patman import settings
Simon Glass131444f2023-02-23 18:18:04 -070031from u_boot_pylib import terminal
32from u_boot_pylib import test_util
33from u_boot_pylib import tools
Simon Glass26132882012-01-14 15:12:45 +000034
Simon Glasseb101ac2020-07-05 21:41:53 -060035epilog = '''Create patches from commits in a branch, check them and email them
36as specified by tags you place in the commits. Use -n to do a dry run first.'''
Simon Glass9c501e12020-07-05 21:41:55 -060037
Simon Glasseb101ac2020-07-05 21:41:53 -060038parser = ArgumentParser(epilog=epilog)
Simon Glass1ee91c12020-11-03 13:54:10 -070039parser.add_argument('-b', '--branch', type=str,
40 help="Branch to process (by default, the current branch)")
41parser.add_argument('-c', '--count', dest='count', type=int,
42 default=-1, help='Automatically create patches from top n commits')
43parser.add_argument('-e', '--end', type=int, default=0,
44 help='Commits to skip at end of patch list')
45parser.add_argument('-D', '--debug', action='store_true',
46 help='Enabling debugging (provides a full traceback on error)')
Simon Glass1908d3542022-01-29 14:14:12 -070047parser.add_argument('-p', '--project', default=project.detect_project(),
Simon Glass1ee91c12020-11-03 13:54:10 -070048 help="Project name; affects default option values and "
49 "aliases [default: %(default)s]")
Simon Glass3d80d792020-11-03 13:54:15 -070050parser.add_argument('-P', '--patchwork-url',
51 default='https://patchwork.ozlabs.org',
52 help='URL of patchwork server [default: %(default)s]')
Simon Glass1ee91c12020-11-03 13:54:10 -070053parser.add_argument('-s', '--start', dest='start', type=int,
54 default=0, help='Commit to start creating patches from (0 = HEAD)')
55parser.add_argument('-v', '--verbose', action='store_true', dest='verbose',
56 default=False, help='Verbose output of errors and warnings')
57parser.add_argument('-H', '--full-help', action='store_true', dest='full_help',
58 default=False, help='Display the README file')
59
Simon Glassecb09da2020-07-05 21:41:54 -060060subparsers = parser.add_subparsers(dest='cmd')
Maxim Cournoyer6a3f71c2022-12-19 17:32:45 -050061send = subparsers.add_parser(
62 'send', help='Format, check and email patches (default command)')
Simon Glassecb09da2020-07-05 21:41:54 -060063send.add_argument('-i', '--ignore-errors', action='store_true',
Simon Glass26132882012-01-14 15:12:45 +000064 dest='ignore_errors', default=False,
65 help='Send patches email even if patch errors are found')
Simon Glassecb09da2020-07-05 21:41:54 -060066send.add_argument('-l', '--limit-cc', dest='limit', type=int, default=None,
67 help='Limit the cc list to LIMIT entries [default: %(default)s]')
68send.add_argument('-m', '--no-maintainers', action='store_false',
Simon Glass46b84d82014-09-14 20:23:17 -060069 dest='add_maintainers', default=True,
70 help="Don't cc the file maintainers automatically")
Maxim Cournoyer3ef23e92022-12-20 00:28:46 -050071send.add_argument(
72 '--get-maintainer-script', dest='get_maintainer_script', type=str,
73 action='store',
74 default=os.path.join(gitutil.get_top_level(), 'scripts',
75 'get_maintainer.pl') + ' --norolestats',
76 help='File name of the get_maintainer.pl (or compatible) script.')
Simon Glassecb09da2020-07-05 21:41:54 -060077send.add_argument('-n', '--dry-run', action='store_true', dest='dry_run',
Simon Glass33bdd9e2013-03-26 13:09:45 +000078 default=False, help="Do a dry run (create but don't email patches)")
Simon Glassecb09da2020-07-05 21:41:54 -060079send.add_argument('-r', '--in-reply-to', type=str, action='store',
Doug Anderson06f27ac2013-03-17 10:31:04 +000080 help="Message ID that this series is in reply to")
Simon Glassecb09da2020-07-05 21:41:54 -060081send.add_argument('-t', '--ignore-bad-tags', action='store_true',
Simon Glass1f975b92021-01-23 08:56:15 -070082 default=False,
83 help='Ignore bad tags / aliases (default=warn)')
Simon Glassecb09da2020-07-05 21:41:54 -060084send.add_argument('-T', '--thread', action='store_true', dest='thread',
85 default=False, help='Create patches as a single thread')
86send.add_argument('--cc-cmd', dest='cc_cmd', type=str, action='store',
Simon Glass26132882012-01-14 15:12:45 +000087 default=None, help='Output cc list for patch file (used by git)')
Simon Glassecb09da2020-07-05 21:41:54 -060088send.add_argument('--no-binary', action='store_true', dest='ignore_binary',
89 default=False,
90 help="Do not output contents of changes in binary files")
91send.add_argument('--no-check', action='store_false', dest='check_patch',
92 default=True,
93 help="Don't check for patch compliance")
Douglas Andersonbe4f2712022-07-19 14:56:27 -070094send.add_argument('--tree', dest='check_patch_use_tree', default=False,
95 action='store_true',
96 help=("Set `tree` to True. If `tree` is False then we'll "
97 "pass '--no-tree' to checkpatch (default: tree=%(default)s)"))
98send.add_argument('--no-tree', dest='check_patch_use_tree',
99 action='store_false', help="Set `tree` to False")
Simon Glassecb09da2020-07-05 21:41:54 -0600100send.add_argument('--no-tags', action='store_false', dest='process_tags',
101 default=True, help="Don't process subject tags as aliases")
Philipp Tomsich858531a2020-11-24 18:14:52 +0100102send.add_argument('--no-signoff', action='store_false', dest='add_signoff',
103 default=True, help="Don't add Signed-off-by to patches")
Simon Glassecb09da2020-07-05 21:41:54 -0600104send.add_argument('--smtp-server', type=str,
105 help="Specify the SMTP server to 'git send-email'")
Maxim Cournoyer12f99fd2023-10-12 23:06:24 -0400106send.add_argument('--keep-change-id', action='store_true',
107 help='Preserve Change-Id tags in patches to send.')
Tom Rini5a9ecb22020-07-24 08:42:06 -0400108
Simon Glassecb09da2020-07-05 21:41:54 -0600109send.add_argument('patchfiles', nargs='*')
Simon Glass9c501e12020-07-05 21:41:55 -0600110
Maxim Cournoyercda00122022-12-19 17:32:43 -0500111# Only add the 'test' action if the test data files are available.
112if os.path.exists(func_test.TEST_DATA_DIR):
113 test_parser = subparsers.add_parser('test', help='Run tests')
114 test_parser.add_argument('testname', type=str, default=None, nargs='?',
115 help="Specify the test to run")
Simon Glass109e84e2020-07-05 21:41:55 -0600116
Simon Glass3db916d2020-10-29 21:46:35 -0600117status = subparsers.add_parser('status',
118 help='Check status of patches in patchwork')
Simon Glass2112d072020-10-29 21:46:38 -0600119status.add_argument('-C', '--show-comments', action='store_true',
120 help='Show comments from each patch')
Simon Glassd0a0a582020-10-29 21:46:36 -0600121status.add_argument('-d', '--dest-branch', type=str,
122 help='Name of branch to create with collected responses')
123status.add_argument('-f', '--force', action='store_true',
124 help='Force overwriting an existing branch')
Simon Glass3db916d2020-10-29 21:46:35 -0600125
Doug Anderson31ffd7f2012-12-03 14:43:18 +0000126# Parse options twice: first to get the project and second to handle
Simon Glass1ee91c12020-11-03 13:54:10 -0700127# defaults properly (which depends on project)
128# Use parse_known_args() in case 'cmd' is omitted
Simon Glasseb101ac2020-07-05 21:41:53 -0600129argv = sys.argv[1:]
Simon Glass1ee91c12020-11-03 13:54:10 -0700130args, rest = parser.parse_known_args(argv)
Simon Glassecb09da2020-07-05 21:41:54 -0600131if hasattr(args, 'project'):
Maxim Cournoyerda6f7cf2022-12-20 00:38:39 -0500132 settings.Setup(parser, args.project)
Simon Glass1ee91c12020-11-03 13:54:10 -0700133 args, rest = parser.parse_known_args(argv)
134
135# If we have a command, it is safe to parse all arguments
136if args.cmd:
137 args = parser.parse_args(argv)
138else:
139 # No command, so insert it after the known arguments and before the ones
140 # that presumably relate to the 'send' subcommand
141 nargs = len(rest)
142 argv = argv[:-nargs] + ['send'] + rest
Simon Glassecb09da2020-07-05 21:41:54 -0600143 args = parser.parse_args(argv)
Simon Glass26132882012-01-14 15:12:45 +0000144
Simon Glass2b68b362015-07-30 13:47:41 -0600145if __name__ != "__main__":
146 pass
147
Simon Glassdbac7162020-07-05 21:41:59 -0600148if not args.debug:
149 sys.tracebacklimit = 0
150
Simon Glass26132882012-01-14 15:12:45 +0000151# Run our meagre tests
Simon Glass109e84e2020-07-05 21:41:55 -0600152if args.cmd == 'test':
Simon Glassa997ea52020-04-17 18:09:04 -0600153 from patman import func_test
Simon Glassc92395b2023-02-23 18:18:07 -0700154 from patman import test_checkpatch
Simon Glass26132882012-01-14 15:12:45 +0000155
Alper Nebi Yasakca1c5882022-04-02 20:06:06 +0300156 result = test_util.run_test_suites(
157 'patman', False, False, False, None, None, None,
Simon Glassc27d22d2022-01-22 05:07:28 -0700158 [test_checkpatch.TestPatch, func_test.TestFunctional,
Simon Glass131444f2023-02-23 18:18:04 -0700159 'gitutil', 'settings'])
Simon Glass26132882012-01-14 15:12:45 +0000160
Alper Nebi Yasakca1c5882022-04-02 20:06:06 +0300161 sys.exit(0 if result.wasSuccessful() else 1)
Tom Rini5a9ecb22020-07-24 08:42:06 -0400162
Simon Glass109e84e2020-07-05 21:41:55 -0600163# Process commits, produce patches files, check them, email them
164elif args.cmd == 'send':
165 # Called from git with a patch filename as argument
166 # Printout a list of additional CC recipients for this patch
167 if args.cc_cmd:
168 fd = open(args.cc_cmd, 'r')
169 re_line = re.compile('(\S*) (.*)')
170 for line in fd.readlines():
171 match = re_line.match(line)
172 if match and match.group(1) == args.patchfiles[0]:
173 for cc in match.group(2).split('\0'):
174 cc = cc.strip()
175 if cc:
176 print(cc)
177 fd.close()
Tom Rini5a9ecb22020-07-24 08:42:06 -0400178
Simon Glass109e84e2020-07-05 21:41:55 -0600179 elif args.full_help:
Maxim Cournoyer124acc92022-12-16 20:45:29 -0500180 with importlib.resources.path('patman', 'README.rst') as readme:
181 tools.print_full_help(str(readme))
Simon Glass109e84e2020-07-05 21:41:55 -0600182 else:
Simon Glass1f975b92021-01-23 08:56:15 -0700183 # If we are not processing tags, no need to warning about bad ones
184 if not args.process_tags:
185 args.ignore_bad_tags = True
Simon Glass109e84e2020-07-05 21:41:55 -0600186 control.send(args)
Simon Glass3db916d2020-10-29 21:46:35 -0600187
188# Check status of patches in patchwork
189elif args.cmd == 'status':
190 ret_code = 0
191 try:
Simon Glassd0a0a582020-10-29 21:46:36 -0600192 control.patchwork_status(args.branch, args.count, args.start, args.end,
Simon Glass2112d072020-10-29 21:46:38 -0600193 args.dest_branch, args.force,
Simon Glass3d80d792020-11-03 13:54:15 -0700194 args.show_comments, args.patchwork_url)
Simon Glass3db916d2020-10-29 21:46:35 -0600195 except Exception as e:
Simon Glass02811582022-01-29 14:14:18 -0700196 terminal.tprint('patman: %s: %s' % (type(e).__name__, e),
Maxim Cournoyerfcf2e852022-12-16 20:45:27 -0500197 colour=terminal.Color.RED)
Simon Glass3db916d2020-10-29 21:46:35 -0600198 if args.debug:
199 print()
200 traceback.print_exc()
201 ret_code = 1
202 sys.exit(ret_code)