]>
git.ipfire.org Git - people/ms/u-boot.git/blob - tools/patman/patman.py
3 # Copyright (c) 2011 The Chromium OS Authors.
5 # SPDX-License-Identifier: GPL-2.0+
8 """See README for more information"""
10 from optparse
import OptionParser
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('-m', '--no-maintainers', action
='store_false',
36 dest
='add_maintainers', default
=True,
37 help="Don't cc the file maintainers automatically")
38 parser
.add_option('-n', '--dry-run', action
='store_true', dest
='dry_run',
39 default
=False, help="Do a dry run (create but don't email patches)")
40 parser
.add_option('-p', '--project', default
=project
.DetectProject(),
41 help="Project name; affects default option values and "
42 "aliases [default: %default]")
43 parser
.add_option('-r', '--in-reply-to', type='string', action
='store',
44 help="Message ID that this series is in reply to")
45 parser
.add_option('-s', '--start', dest
='start', type='int',
46 default
=0, help='Commit to start creating patches from (0 = HEAD)')
47 parser
.add_option('-t', '--ignore-bad-tags', action
='store_true',
48 default
=False, help='Ignore bad tags / aliases')
49 parser
.add_option('--test', action
='store_true', dest
='test',
50 default
=False, help='run tests')
51 parser
.add_option('-v', '--verbose', action
='store_true', dest
='verbose',
52 default
=False, help='Verbose output of errors and warnings')
53 parser
.add_option('--cc-cmd', dest
='cc_cmd', type='string', action
='store',
54 default
=None, help='Output cc list for patch file (used by git)')
55 parser
.add_option('--no-check', action
='store_false', dest
='check_patch',
57 help="Don't check for patch compliance")
58 parser
.add_option('--no-tags', action
='store_false', dest
='process_tags',
59 default
=True, help="Don't process subject tags as aliaes")
63 Create patches from commits in a branch, check them and email them as
64 specified by tags you place in the commits. Use -n to do a dry run first."""
67 # 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()
70 settings
.Setup(parser
, options
.project
, '')
71 (options
, args
) = parser
.parse_args()
73 # Run our meagre tests
77 sys
.argv
= [sys
.argv
[0]]
78 suite
= unittest
.TestLoader().loadTestsFromTestCase(test
.TestPatch
)
79 result
= unittest
.TestResult()
82 for module
in ['gitutil', 'settings']:
83 suite
= doctest
.DocTestSuite(module
)
86 # TODO: Surely we can just 'print' result?
88 for test
, err
in result
.errors
:
90 for test
, err
in result
.failures
:
93 # Called from git with a patch filename as argument
94 # Printout a list of additional CC recipients for this patch
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(', '):
107 elif options
.full_help
:
108 pager
= os
.getenv('PAGER')
111 fname
= os
.path
.join(os
.path
.dirname(sys
.argv
[0]), 'README')
112 command
.Run(pager
, fname
)
114 # Process commits, produce patches files, check them, email them
118 if options
.count
== -1:
119 # Work out how many patches to send if we can
120 options
.count
= gitutil
.CountCommitsToBranch() - options
.start
122 col
= terminal
.Color()
123 if not options
.count
:
124 str = 'No commits found to process - please use -c flag'
125 sys
.exit(col
.Color(col
.RED
, str))
127 # Read the metadata from the commits
129 series
= patchstream
.GetMetaData(options
.start
, options
.count
)
130 cover_fname
, args
= gitutil
.CreatePatches(options
.start
, options
.count
,
133 # Fix up the patch files to our liking, and insert the cover letter
134 series
= patchstream
.FixPatches(series
, args
)
135 if series
and cover_fname
and series
.get('cover'):
136 patchstream
.InsertCoverLetter(cover_fname
, series
, options
.count
)
138 # Do a few checks on the series
141 # Check the patches, and run them through 'git am' just to be sure
142 if options
.check_patch
:
143 ok
= checkpatch
.CheckPatches(options
.verbose
, args
)
147 cc_file
= series
.MakeCcFile(options
.process_tags
, cover_fname
,
148 not options
.ignore_bad_tags
,
149 options
.add_maintainers
)
151 # Email the patches out (giving the user time to check / cancel)
153 its_a_go
= ok
or options
.ignore_errors
155 cmd
= gitutil
.EmailPatches(series
, cover_fname
, args
,
156 options
.dry_run
, not options
.ignore_bad_tags
, cc_file
,
157 in_reply_to
=options
.in_reply_to
)
159 print col
.Color(col
.RED
, "Not sending emails due to errors/warnings")
161 # For a dry run, just show our actions as a sanity check
163 series
.ShowActions(args
, cmd
, options
.process_tags
)
165 print col
.Color(col
.RED
, "Email would not be sent")