mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-03 07:34:17 +00:00
808028b46f
Although each of these command implementations has good output for "west <command> --help", the "west --help" output is missing the one-line descriptions. Add them by modifying west-commands.yml to use a new 'help' key in each command name. These need to be kept in sync with the Python sources. For now just do that by copy/pasting. We could add fancy logic to load the help from west-commands.yml later if we want. Signed-off-by: Marti Bolivar <marti@foundries.io>
80 lines
2.6 KiB
Python
80 lines
2.6 KiB
Python
# Copyright (c) 2018 Open Source Foundries Limited.
|
|
# Copyright 2019 Foundries.io
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
'''west "debug" and "debugserver" commands.'''
|
|
|
|
from textwrap import dedent
|
|
|
|
from west.commands import WestCommand
|
|
|
|
from run_common import desc_common, add_parser_common, do_run_common
|
|
|
|
|
|
class Debug(WestCommand):
|
|
|
|
def __init__(self):
|
|
super(Debug, self).__init__(
|
|
'debug',
|
|
# Keep this in sync with the string in west-commands.yml.
|
|
'flash and interactively debug a Zephyr application',
|
|
dedent('''
|
|
Connect to the board, program the flash, and start a
|
|
debugging session.\n\n''') +
|
|
desc_common('debug'),
|
|
accepts_unknown_args=True)
|
|
|
|
def do_add_parser(self, parser_adder):
|
|
return add_parser_common(parser_adder, self)
|
|
|
|
def do_run(self, my_args, runner_args):
|
|
do_run_common(self, my_args, runner_args,
|
|
'ZEPHYR_BOARD_DEBUG_RUNNER')
|
|
|
|
|
|
class DebugServer(WestCommand):
|
|
|
|
def __init__(self):
|
|
super(DebugServer, self).__init__(
|
|
'debugserver',
|
|
# Keep this in sync with the string in west-commands.yml.
|
|
'connect to board and launch a debug server',
|
|
dedent('''
|
|
Connect to the board and launch a debug server which accepts
|
|
incoming connections for debugging the connected board.
|
|
|
|
The debug server binds to a known port, and allows client software
|
|
started elsewhere to connect to it and debug the running
|
|
Zephyr image.\n\n''') +
|
|
desc_common('debugserver'),
|
|
accepts_unknown_args=True)
|
|
|
|
def do_add_parser(self, parser_adder):
|
|
return add_parser_common(parser_adder, self)
|
|
|
|
def do_run(self, my_args, runner_args):
|
|
do_run_common(self, my_args, runner_args,
|
|
'ZEPHYR_BOARD_DEBUG_RUNNER')
|
|
|
|
|
|
class Attach(WestCommand):
|
|
|
|
def __init__(self):
|
|
super(Attach, self).__init__(
|
|
'attach',
|
|
# Keep this in sync with the string in west-commands.yml.
|
|
'interactively debug a board',
|
|
dedent('''
|
|
Like 'debug', this connects to the board and starts a debugging
|
|
session, but it doesn't reflash the program on the board.\n\n''') +
|
|
desc_common('attach'),
|
|
accepts_unknown_args=True)
|
|
|
|
def do_add_parser(self, parser_adder):
|
|
return add_parser_common(parser_adder, self)
|
|
|
|
def do_run(self, my_args, runner_args):
|
|
do_run_common(self, my_args, runner_args,
|
|
'ZEPHYR_BOARD_DEBUG_RUNNER')
|