tools/buildman/cmdline.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 # Copyright (c) 2014 Google, Inc
   3 #
   4
   5 """Handles parsing of buildman arguments
   6
   7 This creates the argument parser and uses it to parse the arguments passed in
   8 """
   9
  10 from optparse import OptionParser
  11 import os
  12 import pathlib
  13
  14 BUILDMAN_DIR = pathlib.Path(__file__).parent
  15 HAS_TESTS = os.path.exists(BUILDMAN_DIR / "test.py")
  16
  17 def parse_args():
  18     """Parse command line arguments from sys.argv[]
  19
  20     Returns:
  21         tuple containing:
  22             options: command line options
  23             args: command lin arguments
  24     """
  25     parser = OptionParser()
  26     parser.add_option('-a', '--adjust-cfg', type=str, action='append',
  27           help='Adjust the Kconfig settings in .config before building')
  28     parser.add_option('-A', '--print-prefix', action='store_true',
  29           help='Print the tool-chain prefix for a board (CROSS_COMPILE=)')
  30     parser.add_option('-b', '--branch', type='string',
  31           help='Branch name to build, or range of commits to build')
  32     parser.add_option('-B', '--bloat', dest='show_bloat',
  33           action='store_true', default=False,
  34           help='Show changes in function code size for each board')
  35     parser.add_option('--boards', type='string', action='append',
  36           help='List of board names to build separated by comma')
  37     parser.add_option('-c', '--count', dest='count', type='int',
  38           default=-1, help='Run build on the top n commits')
  39     parser.add_option('-C', '--force-reconfig', dest='force_reconfig',
  40           action='store_true', default=False,
  41           help='Reconfigure for every commit (disable incremental build)')
  42     parser.add_option('-d', '--detail', dest='show_detail',
  43           action='store_true', default=False,
  44           help='Show detailed size delta for each board in the -S summary')
  45     parser.add_option('-D', '--config-only', action='store_true', default=False,
  46           help="Don't build, just configure each commit")
  47     parser.add_option('--debug', action='store_true',
  48         help='Enabling debugging (provides a full traceback on error)')
  49     parser.add_option('-e', '--show_errors', action='store_true',
  50           default=False, help='Show errors and warnings')
  51     parser.add_option('-E', '--warnings-as-errors', action='store_true',
  52           default=False, help='Treat all compiler warnings as errors')
  53     parser.add_option('-f', '--force-build', dest='force_build',
  54           action='store_true', default=False,
  55           help='Force build of boards even if already built')
  56     parser.add_option('-F', '--force-build-failures', dest='force_build_failures',
  57           action='store_true', default=False,
  58           help='Force build of previously-failed build')
  59     parser.add_option('--fetch-arch', type='string',
  60           help="Fetch a toolchain for architecture FETCH_ARCH ('list' to list)."
  61               ' You can also fetch several toolchains separate by comma, or'
  62               " 'all' to download all")
  63     parser.add_option('-g', '--git', type='string',
  64           help='Git repo containing branch to build', default='.')
  65     parser.add_option('-G', '--config-file', type='string',
  66           help='Path to buildman config file', default='')
  67     parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
  68           default=False, help='Display the README file')
  69     parser.add_option('-i', '--in-tree', dest='in_tree',
  70           action='store_true', default=False,
  71           help='Build in the source tree instead of a separate directory')
  72     parser.add_option('-I', '--ide', action='store_true', default=False,
  73           help='Create build output that can be parsed by an IDE')
  74     parser.add_option('-j', '--jobs', dest='jobs', type='int',
  75           default=None, help='Number of jobs to run at once (passed to make)')
  76     parser.add_option('-k', '--keep-outputs', action='store_true',
  77           default=False, help='Keep all build output files (e.g. binaries)')
  78     parser.add_option('-K', '--show-config', action='store_true',
  79           default=False,
  80           help='Show configuration changes in summary (both board config files and Kconfig)')
  81     parser.add_option('--preserve-config-y', action='store_true',
  82           default=False, help="Don't convert y to 1 in configs")
  83     parser.add_option('-l', '--list-error-boards', action='store_true',
  84           default=False, help='Show a list of boards next to each error/warning')
  85     parser.add_option('-L', '--no-lto', action='store_true',
  86           default=False, help='Disable Link-time Optimisation (LTO) for builds')
  87     parser.add_option('--list-tool-chains', action='store_true', default=False,
  88           help='List available tool chains (use -v to see probing detail)')
  89     parser.add_option('-m', '--mrproper', action='store_true',
  90           default=False, help="Run 'make mrproper before reconfiguring")
  91     parser.add_option(
  92           '-M', '--allow-missing', action='store_true', default=False,
  93           help='Tell binman to allow missing blobs and generate fake ones as needed')
  94     parser.add_option('--maintainer-check', action='store_true',
  95                       help='Check that maintainer entries exist for each board')
  96     parser.add_option(
  97           '--no-allow-missing', action='store_true', default=False,
  98           help='Disable telling binman to allow missing blobs')
  99     parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
 100           default=False, help="Do a dry run (describe actions, but do nothing)")
 101     parser.add_option('-N', '--no-subdirs', action='store_true', dest='no_subdirs',
 102           default=False,
 103           help="Don't create subdirectories when building current source for a single board")
 104     parser.add_option('-o', '--output-dir', type='string', dest='output_dir',
 105           help='Directory where all builds happen and buildman has its workspace (default is ../)')
 106     parser.add_option('-O', '--override-toolchain', type='string',
 107           help="Override host toochain to use for sandbox (e.g. 'clang-7')")
 108     parser.add_option('-Q', '--quick', action='store_true',
 109           default=False, help='Do a rough build, with limited warning resolution')
 110     parser.add_option('-p', '--full-path', action='store_true',
 111           default=False, help="Use full toolchain path in CROSS_COMPILE")
 112     parser.add_option('-P', '--per-board-out-dir', action='store_true',
 113           default=False, help="Use an O= (output) directory per board rather than per thread")
 114     parser.add_option('-r', '--reproducible-builds', action='store_true',
 115           help='Set SOURCE_DATE_EPOCH=0 to suuport a reproducible build')
 116     parser.add_option('-R', '--regen-board-list', type='string',
 117           help='Force regeneration of the list of boards, like the old boards.cfg file')
 118     parser.add_option('-s', '--summary', action='store_true',
 119           default=False, help='Show a build summary')
 120     parser.add_option('-S', '--show-sizes', action='store_true',
 121           default=False, help='Show image size variation in summary')
 122     parser.add_option('--step', type='int',
 123           default=1, help='Only build every n commits (0=just first and last)')
 124     if HAS_TESTS:
 125         parser.add_option('--skip-net-tests', action='store_true', default=False,
 126                           help='Skip tests which need the network')
 127         parser.add_option('-t', '--test', action='store_true', dest='test',
 128                           default=False, help='run tests')
 129     parser.add_option('-T', '--threads', type='int',
 130           default=None,
 131           help='Number of builder threads to use (0=single-thread)')
 132     parser.add_option('-u', '--show_unknown', action='store_true',
 133           default=False, help='Show boards with unknown build result')
 134     parser.add_option('-U', '--show-environment', action='store_true',
 135           default=False, help='Show environment changes in summary')
 136     parser.add_option('-v', '--verbose', action='store_true',
 137           default=False, help='Show build results while the build progresses')
 138     parser.add_option('-V', '--verbose-build', action='store_true',
 139           default=False, help='Run make with V=1, logging all output')
 140     parser.add_option('-w', '--work-in-output', action='store_true',
 141           default=False, help='Use the output directory as the work directory')
 142     parser.add_option('-W', '--ignore-warnings', action='store_true',
 143           default=False, help='Return success even if there are warnings')
 144     parser.add_option('-x', '--exclude', dest='exclude',
 145           type='string', action='append',
 146           help='Specify a list of boards to exclude, separated by comma')
 147     parser.add_option('-y', '--filter-dtb-warnings', action='store_true',
 148           default=False,
 149           help='Filter out device-tree-compiler warnings from output')
 150     parser.add_option('-Y', '--filter-migration-warnings', action='store_true',
 151           default=False,
 152           help='Filter out migration warnings from output')
 153
 154     parser.usage += """ [list of target/arch/cpu/board/vendor/soc to build]
 155
 156     Build U-Boot for all commits in a branch. Use -n to do a dry run"""
 157
 158     return parser.parse_args()