1#!/usr/bin/python 2# 3# Copyright (c) 2011 The Chromium OS Authors. 4# 5# See file CREDITS for list of people who contributed to this 6# project. 7# 8# This program is free software; you can redistribute it and/or 9# modify it under the terms of the GNU General Public License as 10# published by the Free Software Foundation; either version 2 of 11# the License, or (at your option) any later version. 12# 13# This program is distributed in the hope that it will be useful, 14# but WITHOUT ANY WARRANTY; without even the implied warranty of 15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16# GNU General Public License for more details. 17# 18# You should have received a copy of the GNU General Public License 19# along with this program; if not, write to the Free Software 20# Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21# MA 02111-1307 USA 22# 23 24"""See README for more information""" 25 26from optparse import OptionParser 27import os 28import re 29import sys 30import unittest 31 32# Our modules 33import checkpatch 34import command 35import gitutil 36import patchstream 37import project 38import settings 39import terminal 40import test 41 42 43parser = OptionParser() 44parser.add_option('-H', '--full-help', action='store_true', dest='full_help', 45 default=False, help='Display the README file') 46parser.add_option('-c', '--count', dest='count', type='int', 47 default=-1, help='Automatically create patches from top n commits') 48parser.add_option('-i', '--ignore-errors', action='store_true', 49 dest='ignore_errors', default=False, 50 help='Send patches email even if patch errors are found') 51parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run', 52 default=False, help="Do a try run (create but don't email patches)") 53parser.add_option('-s', '--start', dest='start', type='int', 54 default=0, help='Commit to start creating patches from (0 = HEAD)') 55parser.add_option('-t', '--test', action='store_true', dest='test', 56 default=False, help='run tests') 57parser.add_option('-v', '--verbose', action='store_true', dest='verbose', 58 default=False, help='Verbose output of errors and warnings') 59parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store', 60 default=None, help='Output cc list for patch file (used by git)') 61parser.add_option('--no-tags', action='store_false', dest='process_tags', 62 default=True, help="Don't process subject tags as aliaes") 63parser.add_option('-p', '--project', default=project.DetectProject(), 64 help="Project name; affects default option values and " 65 "aliases [default: %default]") 66 67parser.usage = """patman [options] 68 69Create patches from commits in a branch, check them and email them as 70specified by tags you place in the commits. Use -n to """ 71 72 73# Parse options twice: first to get the project and second to handle 74# defaults properly (which depends on project). 75(options, args) = parser.parse_args() 76settings.Setup(parser, options.project, '') 77(options, args) = parser.parse_args() 78 79# Run our meagre tests 80if options.test: 81 import doctest 82 83 sys.argv = [sys.argv[0]] 84 suite = unittest.TestLoader().loadTestsFromTestCase(test.TestPatch) 85 result = unittest.TestResult() 86 suite.run(result) 87 88 suite = doctest.DocTestSuite('gitutil') 89 suite.run(result) 90 91 # TODO: Surely we can just 'print' result? 92 print result 93 for test, err in result.errors: 94 print err 95 for test, err in result.failures: 96 print err 97 98# Called from git with a patch filename as argument 99# Printout a list of additional CC recipients for this patch 100elif options.cc_cmd: 101 fd = open(options.cc_cmd, 'r') 102 re_line = re.compile('(\S*) (.*)') 103 for line in fd.readlines(): 104 match = re_line.match(line) 105 if match and match.group(1) == args[0]: 106 for cc in match.group(2).split(', '): 107 cc = cc.strip() 108 if cc: 109 print cc 110 fd.close() 111 112elif options.full_help: 113 pager = os.getenv('PAGER') 114 if not pager: 115 pager = 'more' 116 fname = os.path.join(os.path.dirname(sys.argv[0]), 'README') 117 command.Run(pager, fname) 118 119# Process commits, produce patches files, check them, email them 120else: 121 gitutil.Setup() 122 123 if options.count == -1: 124 # Work out how many patches to send if we can 125 options.count = gitutil.CountCommitsToBranch() - options.start 126 127 col = terminal.Color() 128 if not options.count: 129 str = 'No commits found to process - please use -c flag' 130 print col.Color(col.RED, str) 131 sys.exit(1) 132 133 # Read the metadata from the commits 134 if options.count: 135 series = patchstream.GetMetaData(options.start, options.count) 136 cover_fname, args = gitutil.CreatePatches(options.start, options.count, 137 series) 138 139 # Fix up the patch files to our liking, and insert the cover letter 140 series = patchstream.FixPatches(series, args) 141 if series and cover_fname and series.get('cover'): 142 patchstream.InsertCoverLetter(cover_fname, series, options.count) 143 144 # Do a few checks on the series 145 series.DoChecks() 146 147 # Check the patches, and run them through 'git am' just to be sure 148 ok = checkpatch.CheckPatches(options.verbose, args) 149 if not gitutil.ApplyPatches(options.verbose, args, 150 options.count + options.start): 151 ok = False 152 153 cc_file = series.MakeCcFile(options.process_tags, cover_fname) 154 155 # Email the patches out (giving the user time to check / cancel) 156 cmd = '' 157 if ok or options.ignore_errors: 158 cmd = gitutil.EmailPatches(series, cover_fname, args, 159 options.dry_run, cc_file) 160 161 # For a dry run, just show our actions as a sanity check 162 if options.dry_run: 163 series.ShowActions(args, cmd, options.process_tags) 164 165 os.remove(cc_file) 166