2 # SPDX-License-Identifier: GPL-2.0+
4 # Copyright (c) 2011 The Chromium OS Authors.
7 """See README for more information"""
9 from argparse import ArgumentParser
16 if __name__ == "__main__":
17 # Allow 'from patman import xxx to work'
18 our_path = os.path.dirname(os.path.realpath(__file__))
19 sys.path.append(os.path.join(our_path, '..'))
22 from patman import command
23 from patman import control
24 from patman import gitutil
25 from patman import project
26 from patman import settings
27 from patman import terminal
28 from patman import test_util
29 from patman import test_checkpatch
31 epilog = '''Create patches from commits in a branch, check them and email them
32 as specified by tags you place in the commits. Use -n to do a dry run first.'''
34 parser = ArgumentParser(epilog=epilog)
35 parser.add_argument('-b', '--branch', type=str,
36 help="Branch to process (by default, the current branch)")
37 parser.add_argument('-c', '--count', dest='count', type=int,
38 default=-1, help='Automatically create patches from top n commits')
39 parser.add_argument('-e', '--end', type=int, default=0,
40 help='Commits to skip at end of patch list')
41 parser.add_argument('-D', '--debug', action='store_true',
42 help='Enabling debugging (provides a full traceback on error)')
43 parser.add_argument('-p', '--project', default=project.DetectProject(),
44 help="Project name; affects default option values and "
45 "aliases [default: %(default)s]")
46 parser.add_argument('-P', '--patchwork-url',
47 default='https://patchwork.ozlabs.org',
48 help='URL of patchwork server [default: %(default)s]')
49 parser.add_argument('-s', '--start', dest='start', type=int,
50 default=0, help='Commit to start creating patches from (0 = HEAD)')
51 parser.add_argument('-v', '--verbose', action='store_true', dest='verbose',
52 default=False, help='Verbose output of errors and warnings')
53 parser.add_argument('-H', '--full-help', action='store_true', dest='full_help',
54 default=False, help='Display the README file')
56 subparsers = parser.add_subparsers(dest='cmd')
57 send = subparsers.add_parser('send')
58 send.add_argument('-i', '--ignore-errors', action='store_true',
59 dest='ignore_errors', default=False,
60 help='Send patches email even if patch errors are found')
61 send.add_argument('-l', '--limit-cc', dest='limit', type=int, default=None,
62 help='Limit the cc list to LIMIT entries [default: %(default)s]')
63 send.add_argument('-m', '--no-maintainers', action='store_false',
64 dest='add_maintainers', default=True,
65 help="Don't cc the file maintainers automatically")
66 send.add_argument('-n', '--dry-run', action='store_true', dest='dry_run',
67 default=False, help="Do a dry run (create but don't email patches)")
68 send.add_argument('-r', '--in-reply-to', type=str, action='store',
69 help="Message ID that this series is in reply to")
70 send.add_argument('-t', '--ignore-bad-tags', action='store_true',
71 default=False, help='Ignore bad tags / aliases')
72 send.add_argument('-T', '--thread', action='store_true', dest='thread',
73 default=False, help='Create patches as a single thread')
74 send.add_argument('--cc-cmd', dest='cc_cmd', type=str, action='store',
75 default=None, help='Output cc list for patch file (used by git)')
76 send.add_argument('--no-binary', action='store_true', dest='ignore_binary',
78 help="Do not output contents of changes in binary files")
79 send.add_argument('--no-check', action='store_false', dest='check_patch',
81 help="Don't check for patch compliance")
82 send.add_argument('--no-tags', action='store_false', dest='process_tags',
83 default=True, help="Don't process subject tags as aliases")
84 send.add_argument('--smtp-server', type=str,
85 help="Specify the SMTP server to 'git send-email'")
87 send.add_argument('patchfiles', nargs='*')
89 test_parser = subparsers.add_parser('test', help='Run tests')
90 test_parser.add_argument('testname', type=str, default=None, nargs='?',
91 help="Specify the test to run")
93 status = subparsers.add_parser('status',
94 help='Check status of patches in patchwork')
95 status.add_argument('-C', '--show-comments', action='store_true',
96 help='Show comments from each patch')
97 status.add_argument('-d', '--dest-branch', type=str,
98 help='Name of branch to create with collected responses')
99 status.add_argument('-f', '--force', action='store_true',
100 help='Force overwriting an existing branch')
102 # Parse options twice: first to get the project and second to handle
103 # defaults properly (which depends on project)
104 # Use parse_known_args() in case 'cmd' is omitted
106 args, rest = parser.parse_known_args(argv)
107 if hasattr(args, 'project'):
108 settings.Setup(gitutil, parser, args.project, '')
109 args, rest = parser.parse_known_args(argv)
111 # If we have a command, it is safe to parse all arguments
113 args = parser.parse_args(argv)
115 # No command, so insert it after the known arguments and before the ones
116 # that presumably relate to the 'send' subcommand
118 argv = argv[:-nargs] + ['send'] + rest
119 args = parser.parse_args(argv)
121 if __name__ != "__main__":
125 sys.tracebacklimit = 0
127 # Run our meagre tests
128 if args.cmd == 'test':
130 from patman import func_test
132 sys.argv = [sys.argv[0]]
133 result = unittest.TestResult()
134 suite = unittest.TestSuite()
135 loader = unittest.TestLoader()
136 for module in (test_checkpatch.TestPatch, func_test.TestFunctional):
139 suite.addTests(loader.loadTestsFromName(args.testname, module))
140 except AttributeError:
143 suite.addTests(loader.loadTestsFromTestCase(module))
146 for module in ['gitutil', 'settings', 'terminal']:
147 suite = doctest.DocTestSuite(module)
150 sys.exit(test_util.ReportResult('patman', args.testname, result))
152 # Process commits, produce patches files, check them, email them
153 elif args.cmd == 'send':
154 # Called from git with a patch filename as argument
155 # Printout a list of additional CC recipients for this patch
157 fd = open(args.cc_cmd, 'r')
158 re_line = re.compile('(\S*) (.*)')
159 for line in fd.readlines():
160 match = re_line.match(line)
161 if match and match.group(1) == args.patchfiles[0]:
162 for cc in match.group(2).split('\0'):
169 pager = os.getenv('PAGER')
172 fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
174 command.Run(pager, fname)
179 # Check status of patches in patchwork
180 elif args.cmd == 'status':
183 control.patchwork_status(args.branch, args.count, args.start, args.end,
184 args.dest_branch, args.force,
185 args.show_comments, args.patchwork_url)
186 except Exception as e:
187 terminal.Print('patman: %s: %s' % (type(e).__name__, e),
188 colour=terminal.Color.RED)
191 traceback.print_exc()