blob: c60aa5a1c4560e78fbaed1fc1535f83a7b3e89c3 [file] [log] [blame]
Michal Simeke8570752013-05-06 04:11:58 +00001#!/usr/bin/env python
Simon Glass0d24de92012-01-14 15:12:45 +00002#
3# Copyright (c) 2011 The Chromium OS Authors.
4#
Wolfgang Denk1a459662013-07-08 09:37:19 +02005# SPDX-License-Identifier: GPL-2.0+
Simon Glass0d24de92012-01-14 15:12:45 +00006#
7
8"""See README for more information"""
9
10from optparse import OptionParser
11import os
12import re
13import sys
14import unittest
15
16# Our modules
17import checkpatch
18import command
19import gitutil
20import patchstream
Doug Andersona1dcee82012-12-03 14:43:18 +000021import project
Doug Anderson8568bae2012-12-03 14:43:17 +000022import settings
Simon Glass0d24de92012-01-14 15:12:45 +000023import terminal
24import test
25
26
27parser = OptionParser()
Simon Glass902a9712013-03-26 13:09:43 +000028parser.add_option('-a', '--no-apply', action='store_false',
29 dest='apply_patches', default=True,
30 help="Don't test-apply patches with git am")
Simon Glass0d24de92012-01-14 15:12:45 +000031parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
32 default=False, help='Display the README file')
33parser.add_option('-c', '--count', dest='count', type='int',
34 default=-1, help='Automatically create patches from top n commits')
35parser.add_option('-i', '--ignore-errors', action='store_true',
36 dest='ignore_errors', default=False,
37 help='Send patches email even if patch errors are found')
38parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
Simon Glassca706e72013-03-26 13:09:45 +000039 default=False, help="Do a dry run (create but don't email patches)")
Vadim Bendebury99adf6e2013-01-09 16:00:10 +000040parser.add_option('-p', '--project', default=project.DetectProject(),
41 help="Project name; affects default option values and "
42 "aliases [default: %default]")
Doug Anderson6d819922013-03-17 10:31:04 +000043parser.add_option('-r', '--in-reply-to', type='string', action='store',
44 help="Message ID that this series is in reply to")
Simon Glass0d24de92012-01-14 15:12:45 +000045parser.add_option('-s', '--start', dest='start', type='int',
46 default=0, help='Commit to start creating patches from (0 = HEAD)')
Simon Glassa1318f72013-03-26 13:09:42 +000047parser.add_option('-t', '--ignore-bad-tags', action='store_true',
48 default=False, help='Ignore bad tags / aliases')
49parser.add_option('--test', action='store_true', dest='test',
Simon Glass0d24de92012-01-14 15:12:45 +000050 default=False, help='run tests')
51parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
52 default=False, help='Verbose output of errors and warnings')
53parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store',
54 default=None, help='Output cc list for patch file (used by git)')
Vadim Bendebury99adf6e2013-01-09 16:00:10 +000055parser.add_option('--no-check', action='store_false', dest='check_patch',
56 default=True,
57 help="Don't check for patch compliance")
Simon Glass0d24de92012-01-14 15:12:45 +000058parser.add_option('--no-tags', action='store_false', dest='process_tags',
59 default=True, help="Don't process subject tags as aliaes")
60
61parser.usage = """patman [options]
62
63Create patches from commits in a branch, check them and email them as
Simon Glassca706e72013-03-26 13:09:45 +000064specified by tags you place in the commits. Use -n to do a dry run first."""
Simon Glass0d24de92012-01-14 15:12:45 +000065
Doug Anderson8568bae2012-12-03 14:43:17 +000066
Doug Andersona1dcee82012-12-03 14:43:18 +000067# Parse options twice: first to get the project and second to handle
68# defaults properly (which depends on project).
69(options, args) = parser.parse_args()
70settings.Setup(parser, options.project, '')
Simon Glass0d24de92012-01-14 15:12:45 +000071(options, args) = parser.parse_args()
72
73# Run our meagre tests
74if options.test:
75 import doctest
76
77 sys.argv = [sys.argv[0]]
78 suite = unittest.TestLoader().loadTestsFromTestCase(test.TestPatch)
79 result = unittest.TestResult()
80 suite.run(result)
81
Doug Anderson656cffe2012-12-03 14:43:19 +000082 for module in ['gitutil', 'settings']:
83 suite = doctest.DocTestSuite(module)
84 suite.run(result)
Simon Glass0d24de92012-01-14 15:12:45 +000085
86 # TODO: Surely we can just 'print' result?
87 print result
88 for test, err in result.errors:
89 print err
90 for test, err in result.failures:
91 print err
92
93# Called from git with a patch filename as argument
94# Printout a list of additional CC recipients for this patch
95elif options.cc_cmd:
96 fd = open(options.cc_cmd, 'r')
97 re_line = re.compile('(\S*) (.*)')
98 for line in fd.readlines():
99 match = re_line.match(line)
100 if match and match.group(1) == args[0]:
101 for cc in match.group(2).split(', '):
102 cc = cc.strip()
103 if cc:
104 print cc
105 fd.close()
106
107elif options.full_help:
108 pager = os.getenv('PAGER')
109 if not pager:
110 pager = 'more'
111 fname = os.path.join(os.path.dirname(sys.argv[0]), 'README')
112 command.Run(pager, fname)
113
114# Process commits, produce patches files, check them, email them
115else:
116 gitutil.Setup()
117
118 if options.count == -1:
119 # Work out how many patches to send if we can
120 options.count = gitutil.CountCommitsToBranch() - options.start
121
122 col = terminal.Color()
123 if not options.count:
124 str = 'No commits found to process - please use -c flag'
125 print col.Color(col.RED, str)
126 sys.exit(1)
127
128 # Read the metadata from the commits
129 if options.count:
130 series = patchstream.GetMetaData(options.start, options.count)
131 cover_fname, args = gitutil.CreatePatches(options.start, options.count,
132 series)
133
134 # Fix up the patch files to our liking, and insert the cover letter
135 series = patchstream.FixPatches(series, args)
136 if series and cover_fname and series.get('cover'):
137 patchstream.InsertCoverLetter(cover_fname, series, options.count)
138
139 # Do a few checks on the series
140 series.DoChecks()
141
142 # Check the patches, and run them through 'git am' just to be sure
Vadim Bendebury99adf6e2013-01-09 16:00:10 +0000143 if options.check_patch:
144 ok = checkpatch.CheckPatches(options.verbose, args)
145 else:
146 ok = True
Simon Glass902a9712013-03-26 13:09:43 +0000147 if options.apply_patches:
148 if not gitutil.ApplyPatches(options.verbose, args,
149 options.count + options.start):
150 ok = False
Simon Glass0d24de92012-01-14 15:12:45 +0000151
Simon Glassa1318f72013-03-26 13:09:42 +0000152 cc_file = series.MakeCcFile(options.process_tags, cover_fname,
153 not options.ignore_bad_tags)
Doug Andersond94566a2012-12-03 14:40:42 +0000154
Simon Glass0d24de92012-01-14 15:12:45 +0000155 # Email the patches out (giving the user time to check / cancel)
156 cmd = ''
157 if ok or options.ignore_errors:
Simon Glass0d24de92012-01-14 15:12:45 +0000158 cmd = gitutil.EmailPatches(series, cover_fname, args,
Simon Glassa1318f72013-03-26 13:09:42 +0000159 options.dry_run, not options.ignore_bad_tags, cc_file,
160 in_reply_to=options.in_reply_to)
Simon Glass0d24de92012-01-14 15:12:45 +0000161
162 # For a dry run, just show our actions as a sanity check
163 if options.dry_run:
164 series.ShowActions(args, cmd, options.process_tags)
Doug Andersond94566a2012-12-03 14:40:42 +0000165
166 os.remove(cc_file)