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