6e4c2b9be9
Just changes to the west help output; no functional changes expected. Make option descriptions lowercase to match the argparse module's conventions. When multiple sentences are required, move them to parser prolog/epilog or argument group description sections. Clarify some points that have confused multiple people. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
66 lines
2.4 KiB
Python
66 lines
2.4 KiB
Python
# Copyright (c) 2018 Foundries.io
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
'''Helpers shared by multiple west extension command modules.
|
|
|
|
Note that common helpers used by the flash and debug extension
|
|
commands are in run_common -- that's for common code used by
|
|
commands which specifically execute runners.'''
|
|
|
|
import os
|
|
from pathlib import Path
|
|
|
|
from west import log
|
|
from west.commands import WestCommand
|
|
|
|
from runners.core import RunnerConfig
|
|
|
|
# This relies on this file being zephyr/scripts/foo/bar.py.
|
|
# If you move this file, you'll break it, so be careful.
|
|
THIS_ZEPHYR = Path(__file__).parent.parent.parent
|
|
ZEPHYR_BASE = Path(os.environ.get('ZEPHYR_BASE', THIS_ZEPHYR))
|
|
|
|
# FIXME we need a nicer way to handle imports from scripts and cmake than this.
|
|
ZEPHYR_SCRIPTS = ZEPHYR_BASE / 'scripts'
|
|
ZEPHYR_CMAKE = ZEPHYR_BASE / 'cmake'
|
|
|
|
class Forceable(WestCommand):
|
|
'''WestCommand subclass for commands with a --force option.'''
|
|
|
|
@staticmethod
|
|
def add_force_arg(parser):
|
|
'''Add a -f / --force option to the parser.'''
|
|
parser.add_argument('-f', '--force', action='store_true',
|
|
help='ignore any errors and try to proceed')
|
|
|
|
def check_force(self, cond, msg):
|
|
'''Abort if the command needs to be forced and hasn't been.
|
|
|
|
The "forced" predicate must be in self.args.forced.
|
|
|
|
If cond and self.args.force are both False, scream and die
|
|
with message msg. Otherwise, return. That is, "cond" is a
|
|
condition which means everything is OK; if it's False, only
|
|
self.args.force being True can allow execution to proceed.
|
|
'''
|
|
if not (cond or self.args.force):
|
|
log.err(msg)
|
|
log.die('refusing to proceed without --force due to above error')
|
|
|
|
|
|
def cached_runner_config(build_dir, cache):
|
|
'''Parse the RunnerConfig from a build directory and CMake Cache.'''
|
|
board_dir = cache['ZEPHYR_RUNNER_CONFIG_BOARD_DIR']
|
|
elf_file = cache.get('ZEPHYR_RUNNER_CONFIG_KERNEL_ELF')
|
|
hex_file = cache.get('ZEPHYR_RUNNER_CONFIG_KERNEL_HEX')
|
|
bin_file = cache.get('ZEPHYR_RUNNER_CONFIG_KERNEL_BIN')
|
|
gdb = cache.get('ZEPHYR_RUNNER_CONFIG_GDB')
|
|
openocd = cache.get('ZEPHYR_RUNNER_CONFIG_OPENOCD')
|
|
openocd_search = cache.get('ZEPHYR_RUNNER_CONFIG_OPENOCD_SEARCH')
|
|
|
|
return RunnerConfig(build_dir, board_dir,
|
|
elf_file, hex_file, bin_file,
|
|
gdb=gdb, openocd=openocd,
|
|
openocd_search=openocd_search)
|