mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2025-01-18 12:52:44 +01:00
82b7e10988
This adds command completion that, when manually installed, provides
RIOT-aware command completion for `make` in zsh. The completion
supports:
- most commonly used `make` goals including a help text
- most commonly used `make` variables (such as `BOARD=`, `LTO=`,
`BUILD_IN_DOCKER=`, `TOOLCHAIN=`)
- possible values for these variables, including a list of boards
detected at runtime to complete `BOARD=`
Co-authored-by: mguetschow <mikolai.guetschow@tu-dresden.de>
88 lines
3.7 KiB
Bash
88 lines
3.7 KiB
Bash
function _boards {
|
|
local -a _boards_available
|
|
local -a _board_dirs
|
|
_board_dirs=( ${(s[ ])EXTERNAL_BOARD_DIRS} )
|
|
local _repo_root
|
|
if git rev-parse --is-inside-work-tree &> /dev/null; then
|
|
local _repo_root="$(git rev-parse --show-toplevel)"
|
|
_board_dirs+=("$_repo_root/boards")
|
|
fi
|
|
for dir ("$_board_dirs[@]") \
|
|
_boards_available+=($(ls $dir | grep -v common))
|
|
|
|
_describe 'board' _boards_available
|
|
}
|
|
|
|
function _toolchains {
|
|
local -a _toolchains_available=(
|
|
"gnu"
|
|
"llvm"
|
|
)
|
|
|
|
_describe 'toolchain' _toolchains_available
|
|
}
|
|
|
|
function _bools {
|
|
local -a _bool_vals=(
|
|
"0"
|
|
"1"
|
|
)
|
|
|
|
_describe 'bool' _bool_vals
|
|
}
|
|
|
|
function _riot {
|
|
local -a _std_targets=(
|
|
"all:build the application"
|
|
"clean:remove the current build"
|
|
"compile-commands:create a compile_commands.json"
|
|
"cosy:open a webserver detailing the size of the firmware as interactive diagram"
|
|
"debug:open GDB and connect to the embedded board, launching a debug server in background"
|
|
"debug-client:open GDB and connect to an already running debug server"
|
|
"debug-server:launch a debug server for GDB to connect to"
|
|
"flash:build and flash the app on the board"
|
|
"flash-only:only flash the most recently built firmware (even if it is stale)"
|
|
"info-boards-supported:list boards supported by the app"
|
|
"info-build:show details to debug the build"
|
|
"info-build-json:show details of the build as JSON"
|
|
"info-buildsize:print the size of the firmware for the given board"
|
|
"info-buildsizes:print the size of the firmware for every supported board"
|
|
"info-cpu:print the CPU family for the given board"
|
|
"info-features-missing:list features missing by the given baord in regard to the given app"
|
|
"info-features-provided:list features provided by the given board"
|
|
"info-features-required:list features required by the given app"
|
|
"info-features-used:list features of the given board used by the given app"
|
|
"info-modules:list modules used by the given app when build for the given board"
|
|
"info-objsize:list the size of the individual modules (prior garbage collection)"
|
|
"info-packages:list packages used by the given app when build for the given board"
|
|
"info-programmers-supported:list programmers supported by the given board"
|
|
"info-rust:list versions of the used rust toolcahin"
|
|
"info-toolchains-supported:list toolchains supported by the given board"
|
|
"list-ttys:list TTYs connected to the machine"
|
|
"lstfile:dump lots of details of the build firmware in a lstfile"
|
|
"reset:reset the given board (if supported)"
|
|
"term:connect to the serial of the given board"
|
|
"test:runs the python test script(s) of the current app (assumes the current app is flashed)"
|
|
"test-with-config:runs the python test script in the tests-with-config folder"
|
|
)
|
|
|
|
_describe 'target' _std_targets
|
|
_arguments -A '*' \
|
|
'(-C --directory=)'{-C,--directory}'[dir of the app to build]:dir:_directories' \
|
|
#
|
|
|
|
local -a vars
|
|
vars=(
|
|
'BOARD[Select the board to build for]:board:_boards'
|
|
'TOOLCHAIN[Select the toolchain to use]:toolcahin:_toolchains'
|
|
'BUILD_IN_DOCKER[Build inside docker container]:bool:_bools'
|
|
'LTO[Enable link time optimization]:bool:_bools'
|
|
'VERBOSE_ASSERT[Print source file and line on blown assertion]:bool:_bools'
|
|
'QUIET[Reduce verbosity of build output]:bool:_bools'
|
|
'WERROR[Enable/disable -Werror flag]:bool:_bools'
|
|
'RIOT_CI_BUILD[Behave as in the CI: Less verbose output, reproducible builds, ...]:bool:_bools'
|
|
)
|
|
|
|
_values -w 'variables' $vars
|
|
}
|