Simon Glass | e3986d9 | 2019-10-31 07:42:52 -0600 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Tom Rini | 83d290c | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 2 | # SPDX-License-Identifier: GPL-2.0+ |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 3 | # |
| 4 | # Copyright (c) 2011 The Chromium OS Authors. |
| 5 | # |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 6 | |
| 7 | """See README for more information""" |
| 8 | |
| 9 | from optparse import OptionParser |
| 10 | import os |
| 11 | import re |
| 12 | import sys |
| 13 | import unittest |
| 14 | |
Simon Glass | 0d7a8c4 | 2020-04-17 18:08:52 -0600 | [diff] [blame] | 15 | if __name__ == "__main__": |
Simon Glass | b4fa949 | 2020-04-17 18:09:05 -0600 | [diff] [blame] | 16 | # Allow 'from patman import xxx to work' |
Simon Glass | 0d7a8c4 | 2020-04-17 18:08:52 -0600 | [diff] [blame] | 17 | our_path = os.path.dirname(os.path.realpath(__file__)) |
| 18 | sys.path.append(os.path.join(our_path, '..')) |
| 19 | |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 20 | # Our modules |
Simon Glass | bf77667 | 2020-04-17 18:09:04 -0600 | [diff] [blame] | 21 | from patman import command |
Simon Glass | f365375 | 2020-07-05 21:41:49 -0600 | [diff] [blame] | 22 | from patman import control |
Simon Glass | bf77667 | 2020-04-17 18:09:04 -0600 | [diff] [blame] | 23 | from patman import gitutil |
Simon Glass | bf77667 | 2020-04-17 18:09:04 -0600 | [diff] [blame] | 24 | from patman import project |
| 25 | from patman import settings |
| 26 | from patman import terminal |
Simon Glass | 2e9a0cd | 2020-07-05 21:41:48 -0600 | [diff] [blame] | 27 | from patman import test_util |
Simon Glass | 40d9734 | 2020-06-14 10:54:04 -0600 | [diff] [blame] | 28 | from patman import test_checkpatch |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 29 | |
| 30 | |
| 31 | parser = OptionParser() |
| 32 | parser.add_option('-H', '--full-help', action='store_true', dest='full_help', |
| 33 | default=False, help='Display the README file') |
Simon Glass | e9799e0 | 2020-07-05 21:41:51 -0600 | [diff] [blame] | 34 | parser.add_option('-b', '--branch', type='str', |
| 35 | help="Branch to process (by default, the current branch)") |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 36 | parser.add_option('-c', '--count', dest='count', type='int', |
| 37 | default=-1, help='Automatically create patches from top n commits') |
Simon Glass | d9dc99e | 2020-07-05 21:41:52 -0600 | [diff] [blame^] | 38 | parser.add_option('-e', '--end', type='int', default=0, |
| 39 | help='Commits to skip at end of patch list') |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 40 | parser.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 Meng | 0fc01bf | 2020-05-04 00:52:43 -0700 | [diff] [blame] | 43 | parser.add_option('-l', '--limit-cc', dest='limit', type='int', |
| 44 | default=None, help='Limit the cc list to LIMIT entries [default: %default]') |
Simon Glass | 983a274 | 2014-09-14 20:23:17 -0600 | [diff] [blame] | 45 | parser.add_option('-m', '--no-maintainers', action='store_false', |
| 46 | dest='add_maintainers', default=True, |
| 47 | help="Don't cc the file maintainers automatically") |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 48 | parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run', |
Simon Glass | ca706e7 | 2013-03-26 13:09:45 +0000 | [diff] [blame] | 49 | default=False, help="Do a dry run (create but don't email patches)") |
Vadim Bendebury | 99adf6e | 2013-01-09 16:00:10 +0000 | [diff] [blame] | 50 | parser.add_option('-p', '--project', default=project.DetectProject(), |
| 51 | help="Project name; affects default option values and " |
| 52 | "aliases [default: %default]") |
Doug Anderson | 6d81992 | 2013-03-17 10:31:04 +0000 | [diff] [blame] | 53 | parser.add_option('-r', '--in-reply-to', type='string', action='store', |
| 54 | help="Message ID that this series is in reply to") |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 55 | parser.add_option('-s', '--start', dest='start', type='int', |
| 56 | default=0, help='Commit to start creating patches from (0 = HEAD)') |
Simon Glass | a1318f7 | 2013-03-26 13:09:42 +0000 | [diff] [blame] | 57 | parser.add_option('-t', '--ignore-bad-tags', action='store_true', |
| 58 | default=False, help='Ignore bad tags / aliases') |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 59 | parser.add_option('-v', '--verbose', action='store_true', dest='verbose', |
| 60 | default=False, help='Verbose output of errors and warnings') |
Bin Meng | 0fc01bf | 2020-05-04 00:52:43 -0700 | [diff] [blame] | 61 | parser.add_option('-T', '--thread', action='store_true', dest='thread', |
| 62 | default=False, help='Create patches as a single thread') |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 63 | parser.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 Meng | 14aa35a | 2020-05-04 00:52:44 -0700 | [diff] [blame] | 65 | parser.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 Bendebury | 99adf6e | 2013-01-09 16:00:10 +0000 | [diff] [blame] | 68 | parser.add_option('--no-check', action='store_false', dest='check_patch', |
| 69 | default=True, |
| 70 | help="Don't check for patch compliance") |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 71 | parser.add_option('--no-tags', action='store_false', dest='process_tags', |
Sean Anderson | 6949f70 | 2020-05-04 16:28:34 -0400 | [diff] [blame] | 72 | default=True, help="Don't process subject tags as aliases") |
Simon Glass | a60aedf | 2018-06-19 09:56:07 -0600 | [diff] [blame] | 73 | parser.add_option('--smtp-server', type='str', |
| 74 | help="Specify the SMTP server to 'git send-email'") |
Bin Meng | 0fc01bf | 2020-05-04 00:52:43 -0700 | [diff] [blame] | 75 | parser.add_option('--test', action='store_true', dest='test', |
| 76 | default=False, help='run tests') |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 77 | |
Masahiro Yamada | e0a4d06 | 2014-08-21 14:28:03 +0900 | [diff] [blame] | 78 | parser.usage += """ |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 79 | |
| 80 | Create patches from commits in a branch, check them and email them as |
Simon Glass | ca706e7 | 2013-03-26 13:09:45 +0000 | [diff] [blame] | 81 | specified by tags you place in the commits. Use -n to do a dry run first.""" |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 82 | |
Doug Anderson | 8568bae | 2012-12-03 14:43:17 +0000 | [diff] [blame] | 83 | |
Doug Anderson | a1dcee8 | 2012-12-03 14:43:18 +0000 | [diff] [blame] | 84 | # 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 Glass | dd3dac2 | 2020-06-07 06:45:49 -0600 | [diff] [blame] | 87 | settings.Setup(gitutil, parser, options.project, '') |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 88 | (options, args) = parser.parse_args() |
| 89 | |
Simon Glass | 9649e15 | 2015-07-30 13:47:41 -0600 | [diff] [blame] | 90 | if __name__ != "__main__": |
| 91 | pass |
| 92 | |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 93 | # Run our meagre tests |
Simon Glass | 9649e15 | 2015-07-30 13:47:41 -0600 | [diff] [blame] | 94 | elif options.test: |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 95 | import doctest |
Simon Glass | bf77667 | 2020-04-17 18:09:04 -0600 | [diff] [blame] | 96 | from patman import func_test |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 97 | |
| 98 | sys.argv = [sys.argv[0]] |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 99 | result = unittest.TestResult() |
Simon Glass | 40d9734 | 2020-06-14 10:54:04 -0600 | [diff] [blame] | 100 | for module in (test_checkpatch.TestPatch, func_test.TestFunctional): |
Simon Glass | 6e87ae1 | 2017-05-29 15:31:31 -0600 | [diff] [blame] | 101 | suite = unittest.TestLoader().loadTestsFromTestCase(module) |
| 102 | suite.run(result) |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 103 | |
Simon Glass | 37b224f | 2020-04-09 15:08:40 -0600 | [diff] [blame] | 104 | for module in ['gitutil', 'settings', 'terminal']: |
Doug Anderson | 656cffe | 2012-12-03 14:43:19 +0000 | [diff] [blame] | 105 | suite = doctest.DocTestSuite(module) |
| 106 | suite.run(result) |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 107 | |
Simon Glass | 2e9a0cd | 2020-07-05 21:41:48 -0600 | [diff] [blame] | 108 | sys.exit(test_util.ReportResult('patman', None, result)) |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 109 | |
| 110 | # Called from git with a patch filename as argument |
| 111 | # Printout a list of additional CC recipients for this patch |
| 112 | elif 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 Torokhov | 8ab452d | 2019-10-21 20:09:56 -0700 | [diff] [blame] | 118 | for cc in match.group(2).split('\0'): |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 119 | cc = cc.strip() |
| 120 | if cc: |
Paul Burton | a920a17 | 2016-09-27 16:03:50 +0100 | [diff] [blame] | 121 | print(cc) |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 122 | fd.close() |
| 123 | |
| 124 | elif options.full_help: |
| 125 | pager = os.getenv('PAGER') |
| 126 | if not pager: |
| 127 | pager = 'more' |
Simon Glass | 2bdeade | 2016-03-06 19:45:34 -0700 | [diff] [blame] | 128 | fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), |
| 129 | 'README') |
Simon Glass | 0d24de9 | 2012-01-14 15:12:45 +0000 | [diff] [blame] | 130 | command.Run(pager, fname) |
| 131 | |
| 132 | # Process commits, produce patches files, check them, email them |
| 133 | else: |
Simon Glass | f365375 | 2020-07-05 21:41:49 -0600 | [diff] [blame] | 134 | control.send(options) |