tools/patman/main.py

   1 #!/usr/bin/env python3
   2 # SPDX-License-Identifier: GPL-2.0+
   3 #
   4 # Copyright (c) 2011 The Chromium OS Authors.
   5 #
   6
   7 """See README for more information"""
   8
   9 from optparse import OptionParser
  10 import os
  11 import re
  12 import sys
  13 import unittest
  14
  15 if __name__ == "__main__":
  16     # Allow 'from patman import xxx to work'
  17     our_path = os.path.dirname(os.path.realpath(__file__))
  18     sys.path.append(os.path.join(our_path, '..'))
  19
  20 # Our modules
  21 from patman import command
  22 from patman import control
  23 from patman import gitutil
  24 from patman import project
  25 from patman import settings
  26 from patman import terminal
  27 from patman import test_util
  28 from patman import test_checkpatch
  29
  30
  31 parser = OptionParser()
  32 parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
  33        default=False, help='Display the README file')
  34 parser.add_option('-b', '--branch', type='str',
  35                   help="Branch to process (by default, the current branch)")
  36 parser.add_option('-c', '--count', dest='count', type='int',
  37        default=-1, help='Automatically create patches from top n commits')
  38 parser.add_option('-i', '--ignore-errors', action='store_true',
  39        dest='ignore_errors', default=False,
  40        help='Send patches email even if patch errors are found')
  41 parser.add_option('-l', '--limit-cc', dest='limit', type='int',
  42        default=None, help='Limit the cc list to LIMIT entries [default: %default]')
  43 parser.add_option('-m', '--no-maintainers', action='store_false',
  44        dest='add_maintainers', default=True,
  45        help="Don't cc the file maintainers automatically")
  46 parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
  47        default=False, help="Do a dry run (create but don't email patches)")
  48 parser.add_option('-p', '--project', default=project.DetectProject(),
  49                   help="Project name; affects default option values and "
  50                   "aliases [default: %default]")
  51 parser.add_option('-r', '--in-reply-to', type='string', action='store',
  52                   help="Message ID that this series is in reply to")
  53 parser.add_option('-s', '--start', dest='start', type='int',
  54        default=0, help='Commit to start creating patches from (0 = HEAD)')
  55 parser.add_option('-t', '--ignore-bad-tags', action='store_true',
  56                   default=False, help='Ignore bad tags / aliases')
  57 parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
  58        default=False, help='Verbose output of errors and warnings')
  59 parser.add_option('-T', '--thread', action='store_true', dest='thread',
  60                   default=False, help='Create patches as a single thread')
  61 parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store',
  62        default=None, help='Output cc list for patch file (used by git)')
  63 parser.add_option('--no-binary', action='store_true', dest='ignore_binary',
  64                   default=False,
  65                   help="Do not output contents of changes in binary files")
  66 parser.add_option('--no-check', action='store_false', dest='check_patch',
  67                   default=True,
  68                   help="Don't check for patch compliance")
  69 parser.add_option('--no-tags', action='store_false', dest='process_tags',
  70                   default=True, help="Don't process subject tags as aliases")
  71 parser.add_option('--smtp-server', type='str',
  72                   help="Specify the SMTP server to 'git send-email'")
  73 parser.add_option('--test', action='store_true', dest='test',
  74                   default=False, help='run tests')
  75
  76 parser.usage += """
  77
  78 Create patches from commits in a branch, check them and email them as
  79 specified by tags you place in the commits. Use -n to do a dry run first."""
  80
  81
  82 # Parse options twice: first to get the project and second to handle
  83 # defaults properly (which depends on project).
  84 (options, args) = parser.parse_args()
  85 settings.Setup(gitutil, parser, options.project, '')
  86 (options, args) = parser.parse_args()
  87
  88 if __name__ != "__main__":
  89     pass
  90
  91 # Run our meagre tests
  92 elif options.test:
  93     import doctest
  94     from patman import func_test
  95
  96     sys.argv = [sys.argv[0]]
  97     result = unittest.TestResult()
  98     for module in (test_checkpatch.TestPatch, func_test.TestFunctional):
  99         suite = unittest.TestLoader().loadTestsFromTestCase(module)
 100         suite.run(result)
 101
 102     for module in ['gitutil', 'settings', 'terminal']:
 103         suite = doctest.DocTestSuite(module)
 104         suite.run(result)
 105
 106     sys.exit(test_util.ReportResult('patman', None, result))
 107
 108 # Called from git with a patch filename as argument
 109 # Printout a list of additional CC recipients for this patch
 110 elif options.cc_cmd:
 111     fd = open(options.cc_cmd, 'r')
 112     re_line = re.compile('(\S*) (.*)')
 113     for line in fd.readlines():
 114         match = re_line.match(line)
 115         if match and match.group(1) == args[0]:
 116             for cc in match.group(2).split('\0'):
 117                 cc = cc.strip()
 118                 if cc:
 119                     print(cc)
 120     fd.close()
 121
 122 elif options.full_help:
 123     pager = os.getenv('PAGER')
 124     if not pager:
 125         pager = 'more'
 126     fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
 127                          'README')
 128     command.Run(pager, fname)
 129
 130 # Process commits, produce patches files, check them, email them
 131 else:
 132     control.send(options)