Simon Glass | efeac06 | 2019-10-31 07:42:52 -0600 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 2 | # SPDX-License-Identifier: GPL-2.0+ |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 3 | # |
| 4 | # Copyright (c) 2011 The Chromium OS Authors. |
| 5 | # |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 6 | |
| 7 | """See README for more information""" |
| 8 | |
Simon Glass | eb101ac | 2020-07-05 21:41:53 -0600 | [diff] [blame] | 9 | from argparse import ArgumentParser |
Jan Kiszka | 6d7c40c | 2023-04-22 16:42:48 +0200 | [diff] [blame] | 10 | try: |
| 11 | import importlib.resources |
| 12 | except ImportError: |
| 13 | # for Python 3.6 |
| 14 | import importlib_resources |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 15 | import os |
| 16 | import re |
| 17 | import sys |
Simon Glass | dbac716 | 2020-07-05 21:41:59 -0600 | [diff] [blame] | 18 | import traceback |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 19 | |
Simon Glass | bdaad40 | 2020-04-17 18:08:52 -0600 | [diff] [blame] | 20 | if __name__ == "__main__": |
Simon Glass | 4214316 | 2020-04-17 18:09:05 -0600 | [diff] [blame] | 21 | # Allow 'from patman import xxx to work' |
Simon Glass | bdaad40 | 2020-04-17 18:08:52 -0600 | [diff] [blame] | 22 | our_path = os.path.dirname(os.path.realpath(__file__)) |
| 23 | sys.path.append(os.path.join(our_path, '..')) |
| 24 | |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 25 | # Our modules |
Simon Glass | 24725af | 2020-07-05 21:41:49 -0600 | [diff] [blame] | 26 | from patman import control |
Maxim Cournoyer | cda0012 | 2022-12-19 17:32:43 -0500 | [diff] [blame] | 27 | from patman import func_test |
Maxim Cournoyer | 3ef23e9 | 2022-12-20 00:28:46 -0500 | [diff] [blame] | 28 | from patman import gitutil |
Simon Glass | a997ea5 | 2020-04-17 18:09:04 -0600 | [diff] [blame] | 29 | from patman import project |
| 30 | from patman import settings |
Simon Glass | 131444f | 2023-02-23 18:18:04 -0700 | [diff] [blame] | 31 | from u_boot_pylib import terminal |
| 32 | from u_boot_pylib import test_util |
| 33 | from u_boot_pylib import tools |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 34 | |
Simon Glass | eb101ac | 2020-07-05 21:41:53 -0600 | [diff] [blame] | 35 | epilog = '''Create patches from commits in a branch, check them and email them |
| 36 | as specified by tags you place in the commits. Use -n to do a dry run first.''' |
Simon Glass | 9c501e1 | 2020-07-05 21:41:55 -0600 | [diff] [blame] | 37 | |
Simon Glass | eb101ac | 2020-07-05 21:41:53 -0600 | [diff] [blame] | 38 | parser = ArgumentParser(epilog=epilog) |
Simon Glass | 1ee91c1 | 2020-11-03 13:54:10 -0700 | [diff] [blame] | 39 | parser.add_argument('-b', '--branch', type=str, |
| 40 | help="Branch to process (by default, the current branch)") |
| 41 | parser.add_argument('-c', '--count', dest='count', type=int, |
| 42 | default=-1, help='Automatically create patches from top n commits') |
| 43 | parser.add_argument('-e', '--end', type=int, default=0, |
| 44 | help='Commits to skip at end of patch list') |
| 45 | parser.add_argument('-D', '--debug', action='store_true', |
| 46 | help='Enabling debugging (provides a full traceback on error)') |
Simon Glass | 1908d354 | 2022-01-29 14:14:12 -0700 | [diff] [blame] | 47 | parser.add_argument('-p', '--project', default=project.detect_project(), |
Simon Glass | 1ee91c1 | 2020-11-03 13:54:10 -0700 | [diff] [blame] | 48 | help="Project name; affects default option values and " |
| 49 | "aliases [default: %(default)s]") |
Simon Glass | 3d80d79 | 2020-11-03 13:54:15 -0700 | [diff] [blame] | 50 | parser.add_argument('-P', '--patchwork-url', |
| 51 | default='https://patchwork.ozlabs.org', |
| 52 | help='URL of patchwork server [default: %(default)s]') |
Simon Glass | 1ee91c1 | 2020-11-03 13:54:10 -0700 | [diff] [blame] | 53 | parser.add_argument('-s', '--start', dest='start', type=int, |
| 54 | default=0, help='Commit to start creating patches from (0 = HEAD)') |
| 55 | parser.add_argument('-v', '--verbose', action='store_true', dest='verbose', |
| 56 | default=False, help='Verbose output of errors and warnings') |
| 57 | parser.add_argument('-H', '--full-help', action='store_true', dest='full_help', |
| 58 | default=False, help='Display the README file') |
| 59 | |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 60 | subparsers = parser.add_subparsers(dest='cmd') |
Maxim Cournoyer | 6a3f71c | 2022-12-19 17:32:45 -0500 | [diff] [blame] | 61 | send = subparsers.add_parser( |
| 62 | 'send', help='Format, check and email patches (default command)') |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 63 | send.add_argument('-i', '--ignore-errors', action='store_true', |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 64 | dest='ignore_errors', default=False, |
| 65 | help='Send patches email even if patch errors are found') |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 66 | send.add_argument('-l', '--limit-cc', dest='limit', type=int, default=None, |
| 67 | help='Limit the cc list to LIMIT entries [default: %(default)s]') |
| 68 | send.add_argument('-m', '--no-maintainers', action='store_false', |
Simon Glass | 46b84d8 | 2014-09-14 20:23:17 -0600 | [diff] [blame] | 69 | dest='add_maintainers', default=True, |
| 70 | help="Don't cc the file maintainers automatically") |
Maxim Cournoyer | 3ef23e9 | 2022-12-20 00:28:46 -0500 | [diff] [blame] | 71 | send.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 Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 77 | send.add_argument('-n', '--dry-run', action='store_true', dest='dry_run', |
Simon Glass | 33bdd9e | 2013-03-26 13:09:45 +0000 | [diff] [blame] | 78 | default=False, help="Do a dry run (create but don't email patches)") |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 79 | send.add_argument('-r', '--in-reply-to', type=str, action='store', |
Doug Anderson | 06f27ac | 2013-03-17 10:31:04 +0000 | [diff] [blame] | 80 | help="Message ID that this series is in reply to") |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 81 | send.add_argument('-t', '--ignore-bad-tags', action='store_true', |
Simon Glass | 1f975b9 | 2021-01-23 08:56:15 -0700 | [diff] [blame] | 82 | default=False, |
| 83 | help='Ignore bad tags / aliases (default=warn)') |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 84 | send.add_argument('-T', '--thread', action='store_true', dest='thread', |
| 85 | default=False, help='Create patches as a single thread') |
| 86 | send.add_argument('--cc-cmd', dest='cc_cmd', type=str, action='store', |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 87 | default=None, help='Output cc list for patch file (used by git)') |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 88 | send.add_argument('--no-binary', action='store_true', dest='ignore_binary', |
| 89 | default=False, |
| 90 | help="Do not output contents of changes in binary files") |
| 91 | send.add_argument('--no-check', action='store_false', dest='check_patch', |
| 92 | default=True, |
| 93 | help="Don't check for patch compliance") |
Douglas Anderson | be4f271 | 2022-07-19 14:56:27 -0700 | [diff] [blame] | 94 | send.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)")) |
| 98 | send.add_argument('--no-tree', dest='check_patch_use_tree', |
| 99 | action='store_false', help="Set `tree` to False") |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 100 | send.add_argument('--no-tags', action='store_false', dest='process_tags', |
| 101 | default=True, help="Don't process subject tags as aliases") |
Philipp Tomsich | 858531a | 2020-11-24 18:14:52 +0100 | [diff] [blame] | 102 | send.add_argument('--no-signoff', action='store_false', dest='add_signoff', |
| 103 | default=True, help="Don't add Signed-off-by to patches") |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 104 | send.add_argument('--smtp-server', type=str, |
| 105 | help="Specify the SMTP server to 'git send-email'") |
Maxim Cournoyer | 12f99fd | 2023-10-12 23:06:24 -0400 | [diff] [blame] | 106 | send.add_argument('--keep-change-id', action='store_true', |
| 107 | help='Preserve Change-Id tags in patches to send.') |
Tom Rini | 5a9ecb2 | 2020-07-24 08:42:06 -0400 | [diff] [blame] | 108 | |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 109 | send.add_argument('patchfiles', nargs='*') |
Simon Glass | 9c501e1 | 2020-07-05 21:41:55 -0600 | [diff] [blame] | 110 | |
Maxim Cournoyer | cda0012 | 2022-12-19 17:32:43 -0500 | [diff] [blame] | 111 | # Only add the 'test' action if the test data files are available. |
| 112 | if 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 Glass | 109e84e | 2020-07-05 21:41:55 -0600 | [diff] [blame] | 116 | |
Simon Glass | 3db916d | 2020-10-29 21:46:35 -0600 | [diff] [blame] | 117 | status = subparsers.add_parser('status', |
| 118 | help='Check status of patches in patchwork') |
Simon Glass | 2112d07 | 2020-10-29 21:46:38 -0600 | [diff] [blame] | 119 | status.add_argument('-C', '--show-comments', action='store_true', |
| 120 | help='Show comments from each patch') |
Simon Glass | d0a0a58 | 2020-10-29 21:46:36 -0600 | [diff] [blame] | 121 | status.add_argument('-d', '--dest-branch', type=str, |
| 122 | help='Name of branch to create with collected responses') |
| 123 | status.add_argument('-f', '--force', action='store_true', |
| 124 | help='Force overwriting an existing branch') |
Simon Glass | 3db916d | 2020-10-29 21:46:35 -0600 | [diff] [blame] | 125 | |
Doug Anderson | 31ffd7f | 2012-12-03 14:43:18 +0000 | [diff] [blame] | 126 | # Parse options twice: first to get the project and second to handle |
Simon Glass | 1ee91c1 | 2020-11-03 13:54:10 -0700 | [diff] [blame] | 127 | # defaults properly (which depends on project) |
| 128 | # Use parse_known_args() in case 'cmd' is omitted |
Simon Glass | eb101ac | 2020-07-05 21:41:53 -0600 | [diff] [blame] | 129 | argv = sys.argv[1:] |
Simon Glass | 1ee91c1 | 2020-11-03 13:54:10 -0700 | [diff] [blame] | 130 | args, rest = parser.parse_known_args(argv) |
Simon Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 131 | if hasattr(args, 'project'): |
Maxim Cournoyer | da6f7cf | 2022-12-20 00:38:39 -0500 | [diff] [blame] | 132 | settings.Setup(parser, args.project) |
Simon Glass | 1ee91c1 | 2020-11-03 13:54:10 -0700 | [diff] [blame] | 133 | args, rest = parser.parse_known_args(argv) |
| 134 | |
| 135 | # If we have a command, it is safe to parse all arguments |
| 136 | if args.cmd: |
| 137 | args = parser.parse_args(argv) |
| 138 | else: |
| 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 Glass | ecb09da | 2020-07-05 21:41:54 -0600 | [diff] [blame] | 143 | args = parser.parse_args(argv) |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 144 | |
Simon Glass | 2b68b36 | 2015-07-30 13:47:41 -0600 | [diff] [blame] | 145 | if __name__ != "__main__": |
| 146 | pass |
| 147 | |
Simon Glass | dbac716 | 2020-07-05 21:41:59 -0600 | [diff] [blame] | 148 | if not args.debug: |
| 149 | sys.tracebacklimit = 0 |
| 150 | |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 151 | # Run our meagre tests |
Simon Glass | 109e84e | 2020-07-05 21:41:55 -0600 | [diff] [blame] | 152 | if args.cmd == 'test': |
Simon Glass | a997ea5 | 2020-04-17 18:09:04 -0600 | [diff] [blame] | 153 | from patman import func_test |
Simon Glass | c92395b | 2023-02-23 18:18:07 -0700 | [diff] [blame] | 154 | from patman import test_checkpatch |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 155 | |
Alper Nebi Yasak | ca1c588 | 2022-04-02 20:06:06 +0300 | [diff] [blame] | 156 | result = test_util.run_test_suites( |
| 157 | 'patman', False, False, False, None, None, None, |
Simon Glass | c27d22d | 2022-01-22 05:07:28 -0700 | [diff] [blame] | 158 | [test_checkpatch.TestPatch, func_test.TestFunctional, |
Simon Glass | 131444f | 2023-02-23 18:18:04 -0700 | [diff] [blame] | 159 | 'gitutil', 'settings']) |
Simon Glass | 2613288 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 160 | |
Alper Nebi Yasak | ca1c588 | 2022-04-02 20:06:06 +0300 | [diff] [blame] | 161 | sys.exit(0 if result.wasSuccessful() else 1) |
Tom Rini | 5a9ecb2 | 2020-07-24 08:42:06 -0400 | [diff] [blame] | 162 | |
Simon Glass | 109e84e | 2020-07-05 21:41:55 -0600 | [diff] [blame] | 163 | # Process commits, produce patches files, check them, email them |
| 164 | elif 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 Rini | 5a9ecb2 | 2020-07-24 08:42:06 -0400 | [diff] [blame] | 178 | |
Simon Glass | 109e84e | 2020-07-05 21:41:55 -0600 | [diff] [blame] | 179 | elif args.full_help: |
Maxim Cournoyer | 124acc9 | 2022-12-16 20:45:29 -0500 | [diff] [blame] | 180 | with importlib.resources.path('patman', 'README.rst') as readme: |
| 181 | tools.print_full_help(str(readme)) |
Simon Glass | 109e84e | 2020-07-05 21:41:55 -0600 | [diff] [blame] | 182 | else: |
Simon Glass | 1f975b9 | 2021-01-23 08:56:15 -0700 | [diff] [blame] | 183 | # 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 Glass | 109e84e | 2020-07-05 21:41:55 -0600 | [diff] [blame] | 186 | control.send(args) |
Simon Glass | 3db916d | 2020-10-29 21:46:35 -0600 | [diff] [blame] | 187 | |
| 188 | # Check status of patches in patchwork |
| 189 | elif args.cmd == 'status': |
| 190 | ret_code = 0 |
| 191 | try: |
Simon Glass | d0a0a58 | 2020-10-29 21:46:36 -0600 | [diff] [blame] | 192 | control.patchwork_status(args.branch, args.count, args.start, args.end, |
Simon Glass | 2112d07 | 2020-10-29 21:46:38 -0600 | [diff] [blame] | 193 | args.dest_branch, args.force, |
Simon Glass | 3d80d79 | 2020-11-03 13:54:15 -0700 | [diff] [blame] | 194 | args.show_comments, args.patchwork_url) |
Simon Glass | 3db916d | 2020-10-29 21:46:35 -0600 | [diff] [blame] | 195 | except Exception as e: |
Simon Glass | 0281158 | 2022-01-29 14:14:18 -0700 | [diff] [blame] | 196 | terminal.tprint('patman: %s: %s' % (type(e).__name__, e), |
Maxim Cournoyer | fcf2e85 | 2022-12-16 20:45:27 -0500 | [diff] [blame] | 197 | colour=terminal.Color.RED) |
Simon Glass | 3db916d | 2020-10-29 21:46:35 -0600 | [diff] [blame] | 198 | if args.debug: |
| 199 | print() |
| 200 | traceback.print_exc() |
| 201 | ret_code = 1 |
| 202 | sys.exit(ret_code) |