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-prefix', action='store_true',
  17           help='Print the tool-chain prefix for a board (CROSS_COMPILE=)')
  18     parser.add_option('-b', '--branch', type='string',
  19           help='Branch name to build, or range of commits to build')
  20     parser.add_option('-B', '--bloat', dest='show_bloat',
  21           action='store_true', default=False,
  22           help='Show changes in function code size for each board')
  23     parser.add_option('--boards', type='string', action='append',
  24           help='List of board names to build separated by comma')
  25     parser.add_option('-c', '--count', dest='count', type='int',
  26           default=-1, help='Run build on the top n commits')
  27     parser.add_option('-C', '--force-reconfig', dest='force_reconfig',
  28           action='store_true', default=False,
  29           help='Reconfigure for every commit (disable incremental build)')
  30     parser.add_option('-d', '--detail', dest='show_detail',
  31           action='store_true', default=False,
  32           help='Show detailed size delta for each board in the -S summary')
  33     parser.add_option('-D', '--config-only', action='store_true', default=False,
  34           help="Don't build, just configure each commit")
  35     parser.add_option('-e', '--show_errors', action='store_true',
  36           default=False, help='Show errors and warnings')
  37     parser.add_option('-E', '--warnings-as-errors', action='store_true',
  38           default=False, help='Treat all compiler warnings as errors')
  39     parser.add_option('-f', '--force-build', dest='force_build',
  40           action='store_true', default=False,
  41           help='Force build of boards even if already built')
  42     parser.add_option('-F', '--force-build-failures', dest='force_build_failures',
  43           action='store_true', default=False,
  44           help='Force build of previously-failed build')
  45     parser.add_option('--fetch-arch', type='string',
  46           help="Fetch a toolchain for architecture FETCH_ARCH ('list' to list)."
  47               ' You can also fetch several toolchains separate by comma, or'
  48               " 'all' to download all")
  49     parser.add_option('-g', '--git', type='string',
  50           help='Git repo containing branch to build', default='.')
  51     parser.add_option('-G', '--config-file', type='string',
  52           help='Path to buildman config file', default='')
  53     parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
  54           default=False, help='Display the README file')
  55     parser.add_option('-i', '--in-tree', dest='in_tree',
  56           action='store_true', default=False,
  57           help='Build in the source tree instead of a separate directory')
  58     # -I will be removed after April 2021
  59     parser.add_option('-I', '--incremental', action='store_true',
  60           default=False, help='Deprecated, does nothing. See -m')
  61     parser.add_option('-j', '--jobs', dest='jobs', type='int',
  62           default=None, help='Number of jobs to run at once (passed to make)')
  63     parser.add_option('-k', '--keep-outputs', action='store_true',
  64           default=False, help='Keep all build output files (e.g. binaries)')
  65     parser.add_option('-K', '--show-config', action='store_true',
  66           default=False, help='Show configuration changes in summary (both board config files and Kconfig)')
  67     parser.add_option('--preserve-config-y', action='store_true',
  68           default=False, help="Don't convert y to 1 in configs")
  69     parser.add_option('-l', '--list-error-boards', action='store_true',
  70           default=False, help='Show a list of boards next to each error/warning')
  71     parser.add_option('--list-tool-chains', action='store_true', default=False,
  72           help='List available tool chains (use -v to see probing detail)')
  73     parser.add_option('-m', '--mrproper', action='store_true',
  74           default=False, help="Run 'make mrproper before reconfiguring")
  75     parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
  76           default=False, help="Do a dry run (describe actions, but do nothing)")
  77     parser.add_option('-N', '--no-subdirs', action='store_true', dest='no_subdirs',
  78           default=False, help="Don't create subdirectories when building current source for a single board")
  79     parser.add_option('-o', '--output-dir', type='string',
  80           dest='output_dir', default='..',
  81           help='Directory where all builds happen and buildman has its workspace (default is ../)')
  82     parser.add_option('-O', '--override-toolchain', type='string',
  83           help="Override host toochain to use for sandbox (e.g. 'clang-7')")
  84     parser.add_option('-Q', '--quick', action='store_true',
  85           default=False, help='Do a rough build, with limited warning resolution')
  86     parser.add_option('-p', '--full-path', action='store_true',
  87           default=False, help="Use full toolchain path in CROSS_COMPILE")
  88     parser.add_option('-P', '--per-board-out-dir', action='store_true',
  89           default=False, help="Use an O= (output) directory per board rather than per thread")
  90     parser.add_option('-s', '--summary', action='store_true',
  91           default=False, help='Show a build summary')
  92     parser.add_option('-S', '--show-sizes', action='store_true',
  93           default=False, help='Show image size variation in summary')
  94     parser.add_option('--skip-net-tests', action='store_true', default=False,
  95                       help='Skip tests which need the network')
  96     parser.add_option('--step', type='int',
  97           default=1, help='Only build every n commits (0=just first and last)')
  98     parser.add_option('-t', '--test', action='store_true', dest='test',
  99                       default=False, help='run tests')
 100     parser.add_option('-T', '--threads', type='int',
 101           default=None, help='Number of builder threads to use')
 102     parser.add_option('-u', '--show_unknown', action='store_true',
 103           default=False, help='Show boards with unknown build result')
 104     parser.add_option('-U', '--show-environment', action='store_true',
 105           default=False, help='Show environment changes in summary')
 106     parser.add_option('-v', '--verbose', action='store_true',
 107           default=False, help='Show build results while the build progresses')
 108     parser.add_option('-V', '--verbose-build', action='store_true',
 109           default=False, help='Run make with V=1, logging all output')
 110     parser.add_option('-w', '--work-in-output', action='store_true',
 111           default=False, help='Use the output directory as the work directory')
 112     parser.add_option('-W', '--ignore-warnings', action='store_true',
 113           default=False, help='Return success even if there are warnings')
 114     parser.add_option('-x', '--exclude', dest='exclude',
 115           type='string', action='append',
 116           help='Specify a list of boards to exclude, separated by comma')
 117     parser.add_option('-y', '--filter-dtb-warnings', action='store_true',
 118           default=False,
 119            help='Filter out device-tree-compiler warnings from output')
 120
 121     parser.usage += """ [list of target/arch/cpu/board/vendor/soc to build]
 122
 123     Build U-Boot for all commits in a branch. Use -n to do a dry run"""
 124
 125     return parser.parse_args()