Merge tag 'u-boot-imx-20200108' of https://gitlab.denx.de/u-boot/custodians/u-boot-imx
[oweals/u-boot.git] / tools / buildman / cmdline.py
1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2014 Google, Inc
3 #
4
5 from optparse import OptionParser
6
7 def ParseArgs():
8     """Parse command line arguments from sys.argv[]
9
10     Returns:
11         tuple containing:
12             options: command line options
13             args: command lin arguments
14     """
15     parser = OptionParser()
16     parser.add_option('-a', '--print-arch', action='store_true',
17           help='Print the architecture for a board (ARCH=)')
18     parser.add_option('-A', '--print-prefix', action='store_true',
19           help='Print the tool-chain prefix for a board (CROSS_COMPILE=)')
20     parser.add_option('-b', '--branch', type='string',
21           help='Branch name to build, or range of commits to build')
22     parser.add_option('-B', '--bloat', dest='show_bloat',
23           action='store_true', default=False,
24           help='Show changes in function code size for each board')
25     parser.add_option('--boards', type='string', action='append',
26           help='List of board names to build separated by comma')
27     parser.add_option('-c', '--count', dest='count', type='int',
28           default=-1, help='Run build on the top n commits')
29     parser.add_option('-C', '--force-reconfig', dest='force_reconfig',
30           action='store_true', default=False,
31           help='Reconfigure for every commit (disable incremental build)')
32     parser.add_option('-d', '--detail', dest='show_detail',
33           action='store_true', default=False,
34           help='Show detailed information for each board in summary')
35     parser.add_option('-D', '--config-only', action='store_true', default=False,
36           help="Don't build, just configure each commit")
37     parser.add_option('-e', '--show_errors', action='store_true',
38           default=False, help='Show errors and warnings')
39     parser.add_option('-E', '--warnings-as-errors', action='store_true',
40           default=False, help='Treat all compiler warnings as errors')
41     parser.add_option('-f', '--force-build', dest='force_build',
42           action='store_true', default=False,
43           help='Force build of boards even if already built')
44     parser.add_option('-F', '--force-build-failures', dest='force_build_failures',
45           action='store_true', default=False,
46           help='Force build of previously-failed build')
47     parser.add_option('--fetch-arch', type='string',
48           help="Fetch a toolchain for architecture FETCH_ARCH ('list' to list)."
49               ' You can also fetch several toolchains separate by comma, or'
50               " 'all' to download all")
51     parser.add_option('-g', '--git', type='string',
52           help='Git repo containing branch to build', default='.')
53     parser.add_option('-G', '--config-file', type='string',
54           help='Path to buildman config file', default='')
55     parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
56           default=False, help='Display the README file')
57     parser.add_option('-i', '--in-tree', dest='in_tree',
58           action='store_true', default=False,
59           help='Build in the source tree instead of a separate directory')
60     parser.add_option('-I', '--incremental', action='store_true',
61           default=False, help='Do not run make mrproper (when reconfiguring)')
62     parser.add_option('-j', '--jobs', dest='jobs', type='int',
63           default=None, help='Number of jobs to run at once (passed to make)')
64     parser.add_option('-k', '--keep-outputs', action='store_true',
65           default=False, help='Keep all build output files (e.g. binaries)')
66     parser.add_option('-K', '--show-config', action='store_true',
67           default=False, help='Show configuration changes in summary (both board config files and Kconfig)')
68     parser.add_option('--preserve-config-y', action='store_true',
69           default=False, help="Don't convert y to 1 in configs")
70     parser.add_option('-l', '--list-error-boards', action='store_true',
71           default=False, help='Show a list of boards next to each error/warning')
72     parser.add_option('--list-tool-chains', action='store_true', default=False,
73           help='List available tool chains (use -v to see probing detail)')
74     parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
75           default=False, help="Do a dry run (describe actions, but do nothing)")
76     parser.add_option('-N', '--no-subdirs', action='store_true', dest='no_subdirs',
77           default=False, help="Don't create subdirectories when building current source for a single board")
78     parser.add_option('-o', '--output-dir', type='string',
79           dest='output_dir', default='..',
80           help='Directory where all builds happen and buildman has its workspace (default is ../)')
81     parser.add_option('-O', '--override-toolchain', type='string',
82           help="Override host toochain to use for sandbox (e.g. 'clang-7')")
83     parser.add_option('-Q', '--quick', action='store_true',
84           default=False, help='Do a rough build, with limited warning resolution')
85     parser.add_option('-p', '--full-path', action='store_true',
86           default=False, help="Use full toolchain path in CROSS_COMPILE")
87     parser.add_option('-P', '--per-board-out-dir', action='store_true',
88           default=False, help="Use an O= (output) directory per board rather than per thread")
89     parser.add_option('-s', '--summary', action='store_true',
90           default=False, help='Show a build summary')
91     parser.add_option('-S', '--show-sizes', action='store_true',
92           default=False, help='Show image size variation in summary')
93     parser.add_option('--skip-net-tests', action='store_true', default=False,
94                       help='Skip tests which need the network')
95     parser.add_option('--step', type='int',
96           default=1, help='Only build every n commits (0=just first and last)')
97     parser.add_option('-t', '--test', action='store_true', dest='test',
98                       default=False, help='run tests')
99     parser.add_option('-T', '--threads', type='int',
100           default=None, help='Number of builder threads to use')
101     parser.add_option('-u', '--show_unknown', action='store_true',
102           default=False, help='Show boards with unknown build result')
103     parser.add_option('-U', '--show-environment', action='store_true',
104           default=False, help='Show environment changes in summary')
105     parser.add_option('-v', '--verbose', action='store_true',
106           default=False, help='Show build results while the build progresses')
107     parser.add_option('-V', '--verbose-build', action='store_true',
108           default=False, help='Run make with V=1, logging all output')
109     parser.add_option('-x', '--exclude', dest='exclude',
110           type='string', action='append',
111           help='Specify a list of boards to exclude, separated by comma')
112
113     parser.usage += """ [list of target/arch/cpu/board/vendor/soc to build]
114
115     Build U-Boot for all commits in a branch. Use -n to do a dry run"""
116
117     return parser.parse_args()