| # -*- coding: utf-8 -*- |
| # Copyright 2018 The Chromium OS Authors. All rights reserved. |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| """setup_board builds the sysroot for a board. |
| |
| The setup_board process includes the simple directory creations, installs |
| several configuration files, sets up portage command wrappers and configs, |
| and installs the toolchain and some core dependency packages (e.g. kernel |
| headers, gcc-libs). |
| """ |
| |
| from __future__ import print_function |
| |
| import sys |
| |
| from chromite.lib import build_target_lib |
| from chromite.lib import commandline |
| from chromite.lib import cros_build_lib |
| from chromite.lib import portage_util |
| from chromite.service import sysroot |
| |
| |
| assert sys.version_info >= (3, 6), 'This module requires Python 3.6+' |
| |
| |
| def GetParser(): |
| """Build the argument parser.""" |
| # TODO(crbug.com/922144) Remove underscore separated arguments and the |
| # deprecated message after 2019-06-01. |
| deprecated = 'Argument will be removed 2019-06-01. Use %s instead.' |
| parser = commandline.ArgumentParser(description=__doc__) |
| |
| parser.add_argument('--board', required=True, |
| help='The name of the board to set up.') |
| parser.add_argument('--default', action='store_true', default=False, |
| help='Set the board to the default board in your chroot.') |
| parser.add_argument('--force', action='store_true', default=False, |
| help='Force re-creating the board root.') |
| # The positive and negative versions of the arguments are used. |
| # TODO(saklein) Simplify usages to a single version of the argument. |
| parser.add_argument('--usepkg', action='store_true', default=True, |
| dest='usepkg', help='Use binary packages to bootstrap.') |
| parser.add_argument('--nousepkg', action='store_false', default=True, |
| dest='usepkg', help='Use binary packages to bootstrap.') |
| |
| advanced = parser.add_argument_group('Advanced Options') |
| advanced.add_argument('--accept-licenses', |
| help='Licenses to append to the accept list.') |
| advanced.add_argument('--accept_licenses', |
| deprecated=deprecated % '--accept-licenses', |
| help='Deprecated form of --accept-licenses.') |
| |
| # Build target related arguments. |
| target = parser.add_argument_group('Advanced Build Target Options') |
| target.add_argument('--profile', |
| help='The portage configuration profile to use. Profile ' |
| 'must be located in overlay-board/profiles.') |
| target.add_argument('--variant', help='Board variant.') |
| target.add_argument('--board-root', type='path', help='Board root.') |
| target.add_argument('--board_root', type='path', |
| deprecated=deprecated % '--board-root', |
| help='Deprecated form of --board-root.') |
| |
| # Arguments related to the build itself. |
| build = parser.add_argument_group('Advanced Build Modification Options') |
| build.add_argument('--jobs', type=int, |
| help='Maximum number of packages to build in parallel.') |
| build.add_argument('--regen-configs', action='store_true', default=False, |
| help='Regenerate all config files (useful for ' |
| 'modifying profiles without rebuild).') |
| build.add_argument('--regen_configs', action='store_true', default=False, |
| deprecated=deprecated % '--regen-configs', |
| help='Deprecated form of --regen-configs.') |
| build.add_argument('--quiet', action='store_true', default=False, |
| help="Don't print warnings when board already exists.") |
| build.add_argument('--skip-toolchain-update', action='store_true', |
| default=False, |
| help="Don't update toolchain automatically.") |
| build.add_argument('--skip_toolchain_update', action='store_true', |
| default=False, |
| deprecated=deprecated % '--skip-toolchain-update', |
| help='Deprecated form of --skip-toolchain-update.') |
| build.add_argument('--skip-chroot-upgrade', action='store_true', |
| default=False, |
| help="Don't run the chroot upgrade automatically; " |
| 'use with care.') |
| build.add_argument('--skip_chroot_upgrade', action='store_true', |
| default=False, |
| deprecated=deprecated % '--skip-chroot-upgrade', |
| help='Deprecated form of --skip-chroot-upgrade.') |
| build.add_argument('--skip-board-pkg-init', action='store_true', |
| default=False, |
| help="Don't emerge any packages during setup_board into " |
| 'the board root.') |
| build.add_argument('--skip_board_pkg_init', action='store_true', |
| default=False, |
| deprecated=deprecated % '--skip-board-pkg-init', |
| help='Deprecated form of --skip-board-pkg-init.') |
| build.add_argument('--reuse-pkgs-from-local-boards', dest='reuse_local', |
| action='store_true', default=False, |
| help='Bootstrap from local packages instead of remote ' |
| 'packages.') |
| build.add_argument('--reuse_pkgs_from_local_boards', dest='reuse_local', |
| action='store_true', default=False, |
| deprecated=deprecated % '--reuse-pkgs-from-local-boards', |
| help='Deprecated form of --reuse-pkgs-from-local-boards.') |
| |
| return parser |
| |
| |
| def _ParseArgs(args): |
| """Parse and validate arguments.""" |
| parser = GetParser() |
| opts = parser.parse_args(args) |
| |
| # Translate raw options to config objects. |
| name = '%s_%s' % (opts.board, opts.variant) if opts.variant else opts.board |
| opts.build_target = build_target_lib.BuildTarget(name, |
| build_root=opts.board_root, |
| profile=opts.profile) |
| |
| opts.run_config = sysroot.SetupBoardRunConfig( |
| set_default=opts.default, force=opts.force, usepkg=opts.usepkg, |
| jobs=opts.jobs, regen_configs=opts.regen_configs, quiet=opts.quiet, |
| update_toolchain=not opts.skip_toolchain_update, |
| upgrade_chroot=not opts.skip_chroot_upgrade, |
| init_board_pkgs=not opts.skip_board_pkg_init, |
| local_build=opts.reuse_local) |
| |
| opts.Freeze() |
| return opts |
| |
| |
| def main(argv): |
| opts = _ParseArgs(argv) |
| try: |
| sysroot.SetupBoard(opts.build_target, opts.accept_licenses, opts.run_config) |
| except portage_util.MissingOverlayError as e: |
| # Add a bit more user friendly message as people can typo names easily. |
| cros_build_lib.Die( |
| '%s\n' |
| "Double check the --board setting and make sure you're syncing the " |
| 'right manifest (internal-vs-external).', e) |
| except sysroot.Error as e: |
| cros_build_lib.Die(e) |
