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