mirror of
https://github.com/u-boot/u-boot.git
synced 2025-05-05 19:24:48 +00:00
patman: Split out arg parsing into its own file
Move this code into a separate cmdline module, as is done with the other tools. Use the same HAS_TESTS check as buildman Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass
parent
cac91b0b72
commit
18f8830ab9
2 changed files with 150 additions and 113 deletions
|
|
@ -6,7 +6,6 @@
|
||||||
|
|
||||||
"""See README for more information"""
|
"""See README for more information"""
|
||||||
|
|
||||||
from argparse import ArgumentParser
|
|
||||||
try:
|
try:
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
except ImportError:
|
except ImportError:
|
||||||
|
|
@ -23,128 +22,19 @@ if __name__ == "__main__":
|
||||||
sys.path.append(os.path.join(our_path, '..'))
|
sys.path.append(os.path.join(our_path, '..'))
|
||||||
|
|
||||||
# Our modules
|
# Our modules
|
||||||
|
from patman import cmdline
|
||||||
from patman import control
|
from patman import control
|
||||||
from patman import func_test
|
from patman import func_test
|
||||||
from patman import gitutil
|
|
||||||
from patman import project
|
|
||||||
from patman import settings
|
|
||||||
from u_boot_pylib import terminal
|
from u_boot_pylib import terminal
|
||||||
from u_boot_pylib import test_util
|
from u_boot_pylib import test_util
|
||||||
from u_boot_pylib import tools
|
from u_boot_pylib import tools
|
||||||
|
|
||||||
epilog = '''Create patches from commits in a branch, check them and email them
|
|
||||||
as specified by tags you place in the commits. Use -n to do a dry run first.'''
|
|
||||||
|
|
||||||
parser = ArgumentParser(epilog=epilog)
|
|
||||||
parser.add_argument('-b', '--branch', type=str,
|
|
||||||
help="Branch to process (by default, the current branch)")
|
|
||||||
parser.add_argument('-c', '--count', dest='count', type=int,
|
|
||||||
default=-1, help='Automatically create patches from top n commits')
|
|
||||||
parser.add_argument('-e', '--end', type=int, default=0,
|
|
||||||
help='Commits to skip at end of patch list')
|
|
||||||
parser.add_argument('-D', '--debug', action='store_true',
|
|
||||||
help='Enabling debugging (provides a full traceback on error)')
|
|
||||||
parser.add_argument('-p', '--project', default=project.detect_project(),
|
|
||||||
help="Project name; affects default option values and "
|
|
||||||
"aliases [default: %(default)s]")
|
|
||||||
parser.add_argument('-P', '--patchwork-url',
|
|
||||||
default='https://patchwork.ozlabs.org',
|
|
||||||
help='URL of patchwork server [default: %(default)s]')
|
|
||||||
parser.add_argument('-s', '--start', dest='start', type=int,
|
|
||||||
default=0, help='Commit to start creating patches from (0 = HEAD)')
|
|
||||||
parser.add_argument('-v', '--verbose', action='store_true', dest='verbose',
|
|
||||||
default=False, help='Verbose output of errors and warnings')
|
|
||||||
parser.add_argument('-H', '--full-help', action='store_true', dest='full_help',
|
|
||||||
default=False, help='Display the README file')
|
|
||||||
|
|
||||||
subparsers = parser.add_subparsers(dest='cmd')
|
|
||||||
send = subparsers.add_parser(
|
|
||||||
'send', help='Format, check and email patches (default command)')
|
|
||||||
send.add_argument('-i', '--ignore-errors', action='store_true',
|
|
||||||
dest='ignore_errors', default=False,
|
|
||||||
help='Send patches email even if patch errors are found')
|
|
||||||
send.add_argument('-l', '--limit-cc', dest='limit', type=int, default=None,
|
|
||||||
help='Limit the cc list to LIMIT entries [default: %(default)s]')
|
|
||||||
send.add_argument('-m', '--no-maintainers', action='store_false',
|
|
||||||
dest='add_maintainers', default=True,
|
|
||||||
help="Don't cc the file maintainers automatically")
|
|
||||||
send.add_argument(
|
|
||||||
'--get-maintainer-script', dest='get_maintainer_script', type=str,
|
|
||||||
action='store',
|
|
||||||
default=os.path.join(gitutil.get_top_level(), 'scripts',
|
|
||||||
'get_maintainer.pl') + ' --norolestats',
|
|
||||||
help='File name of the get_maintainer.pl (or compatible) script.')
|
|
||||||
send.add_argument('-n', '--dry-run', action='store_true', dest='dry_run',
|
|
||||||
default=False, help="Do a dry run (create but don't email patches)")
|
|
||||||
send.add_argument('-r', '--in-reply-to', type=str, action='store',
|
|
||||||
help="Message ID that this series is in reply to")
|
|
||||||
send.add_argument('-t', '--ignore-bad-tags', action='store_true',
|
|
||||||
default=False,
|
|
||||||
help='Ignore bad tags / aliases (default=warn)')
|
|
||||||
send.add_argument('-T', '--thread', action='store_true', dest='thread',
|
|
||||||
default=False, help='Create patches as a single thread')
|
|
||||||
send.add_argument('--cc-cmd', dest='cc_cmd', type=str, action='store',
|
|
||||||
default=None, help='Output cc list for patch file (used by git)')
|
|
||||||
send.add_argument('--no-binary', action='store_true', dest='ignore_binary',
|
|
||||||
default=False,
|
|
||||||
help="Do not output contents of changes in binary files")
|
|
||||||
send.add_argument('--no-check', action='store_false', dest='check_patch',
|
|
||||||
default=True,
|
|
||||||
help="Don't check for patch compliance")
|
|
||||||
send.add_argument('--tree', dest='check_patch_use_tree', default=False,
|
|
||||||
action='store_true',
|
|
||||||
help=("Set `tree` to True. If `tree` is False then we'll "
|
|
||||||
"pass '--no-tree' to checkpatch (default: tree=%(default)s)"))
|
|
||||||
send.add_argument('--no-tree', dest='check_patch_use_tree',
|
|
||||||
action='store_false', help="Set `tree` to False")
|
|
||||||
send.add_argument('--no-tags', action='store_false', dest='process_tags',
|
|
||||||
default=True, help="Don't process subject tags as aliases")
|
|
||||||
send.add_argument('--no-signoff', action='store_false', dest='add_signoff',
|
|
||||||
default=True, help="Don't add Signed-off-by to patches")
|
|
||||||
send.add_argument('--smtp-server', type=str,
|
|
||||||
help="Specify the SMTP server to 'git send-email'")
|
|
||||||
send.add_argument('--keep-change-id', action='store_true',
|
|
||||||
help='Preserve Change-Id tags in patches to send.')
|
|
||||||
|
|
||||||
send.add_argument('patchfiles', nargs='*')
|
|
||||||
|
|
||||||
# Only add the 'test' action if the test data files are available.
|
|
||||||
if os.path.exists(func_test.TEST_DATA_DIR):
|
|
||||||
test_parser = subparsers.add_parser('test', help='Run tests')
|
|
||||||
test_parser.add_argument('testname', type=str, default=None, nargs='?',
|
|
||||||
help="Specify the test to run")
|
|
||||||
|
|
||||||
status = subparsers.add_parser('status',
|
|
||||||
help='Check status of patches in patchwork')
|
|
||||||
status.add_argument('-C', '--show-comments', action='store_true',
|
|
||||||
help='Show comments from each patch')
|
|
||||||
status.add_argument('-d', '--dest-branch', type=str,
|
|
||||||
help='Name of branch to create with collected responses')
|
|
||||||
status.add_argument('-f', '--force', action='store_true',
|
|
||||||
help='Force overwriting an existing branch')
|
|
||||||
|
|
||||||
# Parse options twice: first to get the project and second to handle
|
|
||||||
# defaults properly (which depends on project)
|
|
||||||
# Use parse_known_args() in case 'cmd' is omitted
|
|
||||||
argv = sys.argv[1:]
|
|
||||||
args, rest = parser.parse_known_args(argv)
|
|
||||||
if hasattr(args, 'project'):
|
|
||||||
settings.Setup(parser, args.project)
|
|
||||||
args, rest = parser.parse_known_args(argv)
|
|
||||||
|
|
||||||
# If we have a command, it is safe to parse all arguments
|
|
||||||
if args.cmd:
|
|
||||||
args = parser.parse_args(argv)
|
|
||||||
else:
|
|
||||||
# No command, so insert it after the known arguments and before the ones
|
|
||||||
# that presumably relate to the 'send' subcommand
|
|
||||||
nargs = len(rest)
|
|
||||||
argv = argv[:-nargs] + ['send'] + rest
|
|
||||||
args = parser.parse_args(argv)
|
|
||||||
|
|
||||||
if __name__ != "__main__":
|
if __name__ != "__main__":
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
args = cmdline.parse_args()
|
||||||
|
|
||||||
if not args.debug:
|
if not args.debug:
|
||||||
sys.tracebacklimit = 0
|
sys.tracebacklimit = 0
|
||||||
|
|
||||||
|
|
|
||||||
147
tools/patman/cmdline.py
Normal file
147
tools/patman/cmdline.py
Normal file
|
|
@ -0,0 +1,147 @@
|
||||||
|
# SPDX-License-Identifier: GPL-2.0+
|
||||||
|
#
|
||||||
|
# Copyright 2023 Google LLC
|
||||||
|
#
|
||||||
|
|
||||||
|
"""Handles parsing of buildman arguments
|
||||||
|
|
||||||
|
This creates the argument parser and uses it to parse the arguments passed in
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import os
|
||||||
|
import pathlib
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from patman import gitutil
|
||||||
|
from patman import project
|
||||||
|
from patman import settings
|
||||||
|
|
||||||
|
PATMAN_DIR = pathlib.Path(__file__).parent
|
||||||
|
HAS_TESTS = os.path.exists(PATMAN_DIR / "func_test.py")
|
||||||
|
|
||||||
|
def parse_args():
|
||||||
|
"""Parse command line arguments from sys.argv[]
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
tuple containing:
|
||||||
|
options: command line options
|
||||||
|
args: command lin arguments
|
||||||
|
"""
|
||||||
|
epilog = '''Create patches from commits in a branch, check them and email
|
||||||
|
them as specified by tags you place in the commits. Use -n to do a dry
|
||||||
|
run first.'''
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser(epilog=epilog)
|
||||||
|
parser.add_argument('-b', '--branch', type=str,
|
||||||
|
help="Branch to process (by default, the current branch)")
|
||||||
|
parser.add_argument('-c', '--count', dest='count', type=int,
|
||||||
|
default=-1, help='Automatically create patches from top n commits')
|
||||||
|
parser.add_argument('-e', '--end', type=int, default=0,
|
||||||
|
help='Commits to skip at end of patch list')
|
||||||
|
parser.add_argument('-D', '--debug', action='store_true',
|
||||||
|
help='Enabling debugging (provides a full traceback on error)')
|
||||||
|
parser.add_argument('-p', '--project', default=project.detect_project(),
|
||||||
|
help="Project name; affects default option values and "
|
||||||
|
"aliases [default: %(default)s]")
|
||||||
|
parser.add_argument('-P', '--patchwork-url',
|
||||||
|
default='https://patchwork.ozlabs.org',
|
||||||
|
help='URL of patchwork server [default: %(default)s]')
|
||||||
|
parser.add_argument('-s', '--start', dest='start', type=int,
|
||||||
|
default=0, help='Commit to start creating patches from (0 = HEAD)')
|
||||||
|
parser.add_argument(
|
||||||
|
'-v', '--verbose', action='store_true', dest='verbose', default=False,
|
||||||
|
help='Verbose output of errors and warnings')
|
||||||
|
parser.add_argument(
|
||||||
|
'-H', '--full-help', action='store_true', dest='full_help',
|
||||||
|
default=False, help='Display the README file')
|
||||||
|
|
||||||
|
subparsers = parser.add_subparsers(dest='cmd')
|
||||||
|
send = subparsers.add_parser(
|
||||||
|
'send', help='Format, check and email patches (default command)')
|
||||||
|
send.add_argument('-i', '--ignore-errors', action='store_true',
|
||||||
|
dest='ignore_errors', default=False,
|
||||||
|
help='Send patches email even if patch errors are found')
|
||||||
|
send.add_argument('-l', '--limit-cc', dest='limit', type=int, default=None,
|
||||||
|
help='Limit the cc list to LIMIT entries [default: %(default)s]')
|
||||||
|
send.add_argument('-m', '--no-maintainers', action='store_false',
|
||||||
|
dest='add_maintainers', default=True,
|
||||||
|
help="Don't cc the file maintainers automatically")
|
||||||
|
send.add_argument(
|
||||||
|
'--get-maintainer-script', dest='get_maintainer_script', type=str,
|
||||||
|
action='store',
|
||||||
|
default=os.path.join(gitutil.get_top_level(), 'scripts',
|
||||||
|
'get_maintainer.pl') + ' --norolestats',
|
||||||
|
help='File name of the get_maintainer.pl (or compatible) script.')
|
||||||
|
send.add_argument('-n', '--dry-run', action='store_true', dest='dry_run',
|
||||||
|
default=False, help="Do a dry run (create but don't email patches)")
|
||||||
|
send.add_argument('-r', '--in-reply-to', type=str, action='store',
|
||||||
|
help="Message ID that this series is in reply to")
|
||||||
|
send.add_argument('-t', '--ignore-bad-tags', action='store_true',
|
||||||
|
default=False,
|
||||||
|
help='Ignore bad tags / aliases (default=warn)')
|
||||||
|
send.add_argument('-T', '--thread', action='store_true', dest='thread',
|
||||||
|
default=False, help='Create patches as a single thread')
|
||||||
|
send.add_argument('--cc-cmd', dest='cc_cmd', type=str, action='store',
|
||||||
|
default=None, help='Output cc list for patch file (used by git)')
|
||||||
|
send.add_argument('--no-binary', action='store_true', dest='ignore_binary',
|
||||||
|
default=False,
|
||||||
|
help="Do not output contents of changes in binary files")
|
||||||
|
send.add_argument('--no-check', action='store_false', dest='check_patch',
|
||||||
|
default=True,
|
||||||
|
help="Don't check for patch compliance")
|
||||||
|
send.add_argument(
|
||||||
|
'--tree', dest='check_patch_use_tree', default=False,
|
||||||
|
action='store_true',
|
||||||
|
help=("Set `tree` to True. If `tree` is False then we'll pass "
|
||||||
|
"'--no-tree' to checkpatch (default: tree=%(default)s)"))
|
||||||
|
send.add_argument('--no-tree', dest='check_patch_use_tree',
|
||||||
|
action='store_false', help="Set `tree` to False")
|
||||||
|
send.add_argument(
|
||||||
|
'--no-tags', action='store_false', dest='process_tags', default=True,
|
||||||
|
help="Don't process subject tags as aliases")
|
||||||
|
send.add_argument('--no-signoff', action='store_false', dest='add_signoff',
|
||||||
|
default=True, help="Don't add Signed-off-by to patches")
|
||||||
|
send.add_argument('--smtp-server', type=str,
|
||||||
|
help="Specify the SMTP server to 'git send-email'")
|
||||||
|
send.add_argument('--keep-change-id', action='store_true',
|
||||||
|
help='Preserve Change-Id tags in patches to send.')
|
||||||
|
|
||||||
|
send.add_argument('patchfiles', nargs='*')
|
||||||
|
|
||||||
|
# Only add the 'test' action if the test data files are available.
|
||||||
|
if HAS_TESTS:
|
||||||
|
test_parser = subparsers.add_parser('test', help='Run tests')
|
||||||
|
test_parser.add_argument('testname', type=str, default=None, nargs='?',
|
||||||
|
help="Specify the test to run")
|
||||||
|
|
||||||
|
status = subparsers.add_parser('status',
|
||||||
|
help='Check status of patches in patchwork')
|
||||||
|
status.add_argument('-C', '--show-comments', action='store_true',
|
||||||
|
help='Show comments from each patch')
|
||||||
|
status.add_argument(
|
||||||
|
'-d', '--dest-branch', type=str,
|
||||||
|
help='Name of branch to create with collected responses')
|
||||||
|
status.add_argument('-f', '--force', action='store_true',
|
||||||
|
help='Force overwriting an existing branch')
|
||||||
|
|
||||||
|
# Parse options twice: first to get the project and second to handle
|
||||||
|
# defaults properly (which depends on project)
|
||||||
|
# Use parse_known_args() in case 'cmd' is omitted
|
||||||
|
argv = sys.argv[1:]
|
||||||
|
args, rest = parser.parse_known_args(argv)
|
||||||
|
if hasattr(args, 'project'):
|
||||||
|
settings.Setup(parser, args.project)
|
||||||
|
args, rest = parser.parse_known_args(argv)
|
||||||
|
|
||||||
|
# If we have a command, it is safe to parse all arguments
|
||||||
|
if args.cmd:
|
||||||
|
args = parser.parse_args(argv)
|
||||||
|
else:
|
||||||
|
# No command, so insert it after the known arguments and before the ones
|
||||||
|
# that presumably relate to the 'send' subcommand
|
||||||
|
nargs = len(rest)
|
||||||
|
argv = argv[:-nargs] + ['send'] + rest
|
||||||
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
|
return args
|
||||||
Loading…
Add table
Reference in a new issue