2023-01-04 04:10:18 +00:00
""" Compile all keyboards.
This will compile everything in parallel , for testing purposes .
"""
import os
from pathlib import Path
from subprocess import DEVNULL
from milc import cli
from qmk . constants import QMK_FIRMWARE
from qmk . commands import _find_make , get_make_parallel_args
2023-04-04 05:09:55 +00:00
from qmk . keyboard import resolve_keyboard
2023-03-16 20:35:49 +00:00
from qmk . search import search_keymap_targets
2023-01-04 04:10:18 +00:00
2023-03-29 10:26:05 +00:00
@cli.argument ( ' builds ' , nargs = ' * ' , arg_only = True , help = " List of builds in form <keyboard>:<keymap> to compile in parallel. Specifying this overrides all other target search options. " )
2023-01-04 04:10:18 +00:00
@cli.argument ( ' -t ' , ' --no-temp ' , arg_only = True , action = ' store_true ' , help = " Remove temporary files during build. " )
@cli.argument ( ' -j ' , ' --parallel ' , type = int , default = 1 , help = " Set the number of parallel make jobs; 0 means unlimited. " )
@cli.argument ( ' -c ' , ' --clean ' , arg_only = True , action = ' store_true ' , help = " Remove object files before compiling. " )
2023-09-22 02:12:20 +00:00
@cli.argument ( ' -n ' , ' --dry-run ' , arg_only = True , action = ' store_true ' , help = " Don ' t actually build, just show the commands to be run. " )
2023-01-04 04:10:18 +00:00
@cli.argument (
' -f ' ,
' --filter ' ,
arg_only = True ,
action = ' append ' ,
default = [ ] ,
2023-01-18 22:36:32 +00:00
help = # noqa: `format-python` and `pytest` don't agree here.
2023-02-19 02:04:50 +00:00
" Filter the list of keyboards based on the supplied value in rules.mk. Matches info.json structure, and accepts the formats ' features.rgblight=true ' or ' exists(matrix_pins.direct) ' . May be passed multiple times, all filters need to match. Value may include wildcards such as ' * ' and ' ? ' . " # noqa: `format-python` and `pytest` don't agree here.
2023-01-04 04:10:18 +00:00
)
@cli.argument ( ' -km ' , ' --keymap ' , type = str , default = ' default ' , help = " The keymap name to build. Default is ' default ' . " )
@cli.argument ( ' -e ' , ' --env ' , arg_only = True , action = ' append ' , default = [ ] , help = " Set a variable to be passed to make. May be passed multiple times. " )
@cli.subcommand ( ' Compile QMK Firmware for all keyboards. ' , hidden = False if cli . config . user . developer else True )
def mass_compile ( cli ) :
""" Compile QMK Firmware against all keyboards.
"""
make_cmd = _find_make ( )
if cli . args . clean :
cli . run ( [ make_cmd , ' clean ' ] , capture_output = False , stdin = DEVNULL )
builddir = Path ( QMK_FIRMWARE ) / ' .build '
makefile = builddir / ' parallel_kb_builds.mk '
2023-03-29 10:26:05 +00:00
if len ( cli . args . builds ) > 0 :
2023-04-04 05:09:55 +00:00
targets = list ( sorted ( set ( [ ( resolve_keyboard ( e [ 0 ] ) , e [ 1 ] ) for e in [ b . split ( ' : ' ) for b in cli . args . builds ] ] ) ) )
2023-03-29 10:26:05 +00:00
else :
targets = search_keymap_targets ( cli . args . keymap , cli . args . filter )
2023-01-04 04:10:18 +00:00
if len ( targets ) == 0 :
return
2023-09-22 02:12:20 +00:00
if cli . args . dry_run :
cli . log . info ( ' Compilation targets: ' )
2023-01-04 04:10:18 +00:00
for target in sorted ( targets ) :
2023-09-22 02:12:20 +00:00
cli . log . info ( f " {{ fg_cyan }} qmk compile -kb { target [ 0 ] } -km { target [ 1 ] } {{ fg_reset }} " )
else :
builddir . mkdir ( parents = True , exist_ok = True )
with open ( makefile , " w " ) as f :
for target in sorted ( targets ) :
keyboard_name = target [ 0 ]
keymap_name = target [ 1 ]
keyboard_safe = keyboard_name . replace ( ' / ' , ' _ ' )
build_log = f " { QMK_FIRMWARE } /.build/build.log. { os . getpid ( ) } . { keyboard_safe } . { keymap_name } "
failed_log = f " { QMK_FIRMWARE } /.build/failed.log. { os . getpid ( ) } . { keyboard_safe } . { keymap_name } "
2023-01-04 04:10:18 +00:00
# yapf: disable
f . write (
f """ \
2023-09-22 02:12:20 +00:00
all : { keyboard_safe } _ { keymap_name } _binary
{ keyboard_safe } _ { keymap_name } _binary :
@rm - f " {build_log} " | | true
@echo " Compiling QMK Firmware for target: ' {keyboard_name} : {keymap_name} ' ... " >> " {build_log} "
+ @ $ ( MAKE ) - C " {QMK_FIRMWARE} " - f " {QMK_FIRMWARE} /builddefs/build_keyboard.mk " KEYBOARD = " {keyboard_name} " KEYMAP = " {keymap_name} " COLOR = true SILENT = false { ' ' . join ( cli . args . env ) } \\
>> " {build_log} " 2 > & 1 \\
| | cp " {build_log} " " {failed_log} "
@ { { grep ' \ [ERRORS \ ] ' " {build_log} " > / dev / null 2 > & 1 & & printf " Build %-64s \ e[1;31m[ERRORS] \ e[0m \\ n " " {keyboard_name} : {keymap_name} " ; } } \\
| | { { grep ' \ [WARNINGS \ ] ' " {build_log} " > / dev / null 2 > & 1 & & printf " Build %-64s \ e[1;33m[WARNINGS] \ e[0m \\ n " " {keyboard_name} : {keymap_name} " ; } } \\
| | printf " Build %-64s \ e[1;32m[OK] \ e[0m \\ n " " {keyboard_name} : {keymap_name} "
@rm - f " {build_log} " | | true
""" # noqa
2023-01-04 04:10:18 +00:00
)
# yapf: enable
2023-09-22 02:12:20 +00:00
if cli . args . no_temp :
# yapf: disable
f . write (
f """ \
@rm - rf " {QMK_FIRMWARE} /.build/ {keyboard_safe} _ {keymap_name} .elf " 2 > / dev / null | | true
@rm - rf " {QMK_FIRMWARE} /.build/ {keyboard_safe} _ {keymap_name} .map " 2 > / dev / null | | true
@rm - rf " {QMK_FIRMWARE} /.build/obj_ {keyboard_safe} _ {keymap_name} " | | true
""" # noqa
)
# yapf: enable
f . write ( ' \n ' )
cli . run ( [ make_cmd , * get_make_parallel_args ( cli . args . parallel ) , ' -f ' , makefile . as_posix ( ) , ' all ' ] , capture_output = False , stdin = DEVNULL )
2023-01-04 04:10:18 +00:00
2023-09-22 02:12:20 +00:00
# Check for failures
failures = [ f for f in builddir . glob ( f ' failed.log. { os . getpid ( ) } .* ' ) ]
if len ( failures ) > 0 :
return False