1 # SPDX-License-Identifier: GPL-2.0+
3 # Copyright 2020 Google LLC
5 """Handles the main control logic of patman
7 This module provides various functions called by the main program to implement
8 the features of patman.
14 from patman import checkpatch
15 from patman import gitutil
16 from patman import patchstream
17 from patman import terminal
20 """Do required setup before doing anything"""
23 def prepare_patches(col, branch, count, start, end, ignore_binary):
24 """Figure out what patches to generate, then generate them
26 The patch files are written to the current directory, e.g. 0001_xxx.patch
30 col (terminal.Color): Colour output object
31 branch (str): Branch to create patches from (None = current)
32 count (int): Number of patches to produce, or -1 to produce patches for
33 the current branch back to the upstream commit
34 start (int): Start partch to use (0=first / top of branch)
35 end (int): End patch to use (0=last one in series, 1=one before that,
37 ignore_binary (bool): Don't generate patches for binary files
41 Series object for this series (set of patches)
42 Filename of the cover letter as a string (None if none)
43 patch_files: List of patch filenames, each a string, e.g.
44 ['0001_xxx.patch', '0002_yyy.patch']
47 # Work out how many patches to send if we can
48 count = (gitutil.CountCommitsToBranch(branch) - start)
51 sys.exit(col.Color(col.RED,
52 'No commits found to process - please use -c flag'))
54 # Read the metadata from the commits
56 series = patchstream.GetMetaData(branch, start, to_do)
57 cover_fname, patch_files = gitutil.CreatePatches(
58 branch, start, to_do, ignore_binary, series)
60 # Fix up the patch files to our liking, and insert the cover letter
61 patchstream.FixPatches(series, patch_files)
62 if cover_fname and series.get('cover'):
63 patchstream.InsertCoverLetter(cover_fname, series, to_do)
64 return series, cover_fname, patch_files
66 def check_patches(series, patch_files, run_checkpatch, verbose):
67 """Run some checks on a set of patches
69 This santiy-checks the patman tags like Series-version and runs the patches
73 series (Series): Series object for this series (set of patches)
74 patch_files (list): List of patch filenames, each a string, e.g.
75 ['0001_xxx.patch', '0002_yyy.patch']
76 run_checkpatch (bool): True to run checkpatch.pl
77 verbose (bool): True to print out every line of the checkpatch output as
81 bool: True if the patches had no errors, False if they did
83 # Do a few checks on the series
86 # Check the patches, and run them through 'git am' just to be sure
88 ok = checkpatch.CheckPatches(verbose, patch_files)
94 def email_patches(col, series, cover_fname, patch_files, process_tags, its_a_go,
95 ignore_bad_tags, add_maintainers, limit, dry_run, in_reply_to,
97 """Email patches to the recipients
99 This emails out the patches and cover letter using 'git send-email'. Each
100 patch is copied to recipients identified by the patch tag and output from
101 the get_maintainer.pl script. The cover letter is copied to all recipients
104 To make this work a CC file is created holding the recipients for each patch
105 and the cover letter. See the main program 'cc_cmd' for this logic.
108 col (terminal.Color): Colour output object
109 series (Series): Series object for this series (set of patches)
110 cover_fname (str): Filename of the cover letter as a string (None if
112 patch_files (list): List of patch filenames, each a string, e.g.
113 ['0001_xxx.patch', '0002_yyy.patch']
114 process_tags (bool): True to process subject tags in each patch, e.g.
115 for 'dm: spi: Add SPI support' this would be 'dm' and 'spi'. The
116 tags are looked up in the configured sendemail.aliasesfile and also
117 in ~/.patman (see README)
118 its_a_go (bool): True if we are going to actually send the patches,
119 False if the patches have errors and will not be sent unless
121 ignore_bad_tags (bool): True to just print a warning for unknown tags,
122 False to halt with an error
123 add_maintainers (bool): Run the get_maintainer.pl script for each patch
124 limit (int): Limit on the number of people that can be cc'd on a single
125 patch or the cover letter (None if no limit)
126 dry_run (bool): Don't actually email the patches, just print out what
128 in_reply_to (str): If not None we'll pass this to git as --in-reply-to.
129 Should be a message ID that this is in reply to.
130 thread (bool): True to add --thread to git send-email (make all patches
131 reply to cover-letter or first patch in series)
132 smtp_server (str): SMTP server to use to send patches (None for default)
134 cc_file = series.MakeCcFile(process_tags, cover_fname, not ignore_bad_tags,
135 add_maintainers, limit)
137 # Email the patches out (giving the user time to check / cancel)
140 cmd = gitutil.EmailPatches(
141 series, cover_fname, patch_files, dry_run, not ignore_bad_tags,
142 cc_file, in_reply_to=in_reply_to, thread=thread,
143 smtp_server=smtp_server)
145 print(col.Color(col.RED, "Not sending emails due to errors/warnings"))
147 # For a dry run, just show our actions as a sanity check
149 series.ShowActions(patch_files, cmd, process_tags)
151 print(col.Color(col.RED, "Email would not be sent"))
156 """Create, check and send patches by email
159 options (optparse.Values): Arguments to patman
162 col = terminal.Color()
163 series, cover_fname, patch_files = prepare_patches(
164 col, options.branch, options.count, options.start, options.end,
165 options.ignore_binary)
166 ok = check_patches(series, patch_files, options.check_patch,
169 its_a_go = ok or options.ignore_errors
172 col, series, cover_fname, patch_files, options.process_tags,
173 its_a_go, options.ignore_bad_tags, options.add_maintainers,
174 options.limit, options.dry_run, options.in_reply_to, options.thread,