Userspace: add support for adding environment variables during build (#22887)
This commit is contained in:
Nick Brassel
GitHub
parent
158aaef78c
commit
380e0c9cad
17 changed files with 372 additions and 159 deletions
|
|
@ -18,11 +18,18 @@ def _detect_json_format(file, json_data):
|
|||
"""
|
||||
json_encoder = None
|
||||
try:
|
||||
validate(json_data, 'qmk.user_repo.v1')
|
||||
validate(json_data, 'qmk.user_repo.v1_1')
|
||||
json_encoder = UserspaceJSONEncoder
|
||||
except ValidationError:
|
||||
pass
|
||||
|
||||
if json_encoder is None:
|
||||
try:
|
||||
validate(json_data, 'qmk.user_repo.v1')
|
||||
json_encoder = UserspaceJSONEncoder
|
||||
except ValidationError:
|
||||
pass
|
||||
|
||||
if json_encoder is None:
|
||||
try:
|
||||
validate(json_data, 'qmk.keyboard.v1')
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ from typing import List
|
|||
from pathlib import Path
|
||||
from subprocess import DEVNULL
|
||||
from milc import cli
|
||||
import shlex
|
||||
|
||||
from qmk.constants import QMK_FIRMWARE
|
||||
from qmk.commands import find_make, get_make_parallel_args, build_environment
|
||||
|
|
@ -26,7 +27,8 @@ def mass_compile_targets(targets: List[BuildTarget], clean: bool, dry_run: bool,
|
|||
if dry_run:
|
||||
cli.log.info('Compilation targets:')
|
||||
for target in sorted(targets, key=lambda t: (t.keyboard, t.keymap)):
|
||||
cli.log.info(f"{{fg_cyan}}qmk compile -kb {target.keyboard} -km {target.keymap}{{fg_reset}}")
|
||||
extra_args = ' '.join([f"-e {shlex.quote(f'{k}={v}')}" for k, v in target.extra_args.items()])
|
||||
cli.log.info(f"{{fg_cyan}}qmk compile -kb {target.keyboard} -km {target.keymap} {extra_args}{{fg_reset}}")
|
||||
else:
|
||||
if clean:
|
||||
cli.run([make_cmd, 'clean'], capture_output=False, stdin=DEVNULL)
|
||||
|
|
@ -36,18 +38,26 @@ def mass_compile_targets(targets: List[BuildTarget], clean: bool, dry_run: bool,
|
|||
for target in sorted(targets, key=lambda t: (t.keyboard, t.keymap)):
|
||||
keyboard_name = target.keyboard
|
||||
keymap_name = target.keymap
|
||||
keyboard_safe = keyboard_name.replace('/', '_')
|
||||
target_filename = target.target_name(**env)
|
||||
target.configure(parallel=1) # We ignore parallelism on a per-build basis as we defer to the parent make invocation
|
||||
target.prepare_build(**env) # If we've got json targets, allow them to write out any extra info to .build before we kick off `make`
|
||||
command = target.compile_command(**env)
|
||||
command[0] = '+@$(MAKE)' # Override the make so that we can use jobserver to handle parallelism
|
||||
keyboard_safe = keyboard_name.replace('/', '_')
|
||||
extra_args = '_'.join([f"{k}_{v}" for k, v in target.extra_args.items()])
|
||||
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}"
|
||||
target_suffix = ''
|
||||
if len(extra_args) > 0:
|
||||
build_log += f".{extra_args}"
|
||||
failed_log += f".{extra_args}"
|
||||
target_suffix = f"_{extra_args}"
|
||||
# yapf: disable
|
||||
f.write(
|
||||
f"""\
|
||||
all: {keyboard_safe}_{keymap_name}_binary
|
||||
{keyboard_safe}_{keymap_name}_binary:
|
||||
.PHONY: {target_filename}{target_suffix}_binary
|
||||
all: {target_filename}{target_suffix}_binary
|
||||
{target_filename}{target_suffix}_binary:
|
||||
@rm -f "{build_log}" || true
|
||||
@echo "Compiling QMK Firmware for target: '{keyboard_name}:{keymap_name}'..." >>"{build_log}"
|
||||
{' '.join(command)} \\
|
||||
|
|
@ -65,9 +75,9 @@ all: {keyboard_safe}_{keymap_name}_binary
|
|||
# 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
|
||||
@rm -rf "{QMK_FIRMWARE}/.build/{target_filename}.elf" 2>/dev/null || true
|
||||
@rm -rf "{QMK_FIRMWARE}/.build/{target_filename}.map" 2>/dev/null || true
|
||||
@rm -rf "{QMK_FIRMWARE}/.build/obj_{target_filename}" || true
|
||||
"""# noqa
|
||||
)
|
||||
# yapf: enable
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
# Copyright 2023 Nick Brassel (@tzarc)
|
||||
# Copyright 2023-2024 Nick Brassel (@tzarc)
|
||||
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||
from pathlib import Path
|
||||
from milc import cli
|
||||
|
||||
from qmk.commands import parse_env_vars
|
||||
from qmk.constants import QMK_USERSPACE, HAS_QMK_USERSPACE
|
||||
from qmk.keyboard import keyboard_completer, keyboard_folder_or_all
|
||||
from qmk.keymap import keymap_completer, is_keymap_target
|
||||
|
|
@ -12,12 +13,15 @@ from qmk.userspace import UserspaceDefs
|
|||
@cli.argument('builds', nargs='*', arg_only=True, help="List of builds in form <keyboard>:<keymap>, or path to a keymap JSON file.")
|
||||
@cli.argument('-kb', '--keyboard', type=keyboard_folder_or_all, completer=keyboard_completer, help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.')
|
||||
@cli.argument('-km', '--keymap', completer=keymap_completer, help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')
|
||||
@cli.argument('-e', '--env', arg_only=True, action='append', default=[], help="Extra variables to set during build. May be passed multiple times.")
|
||||
@cli.subcommand('Adds a build target to userspace `qmk.json`.')
|
||||
def userspace_add(cli):
|
||||
if not HAS_QMK_USERSPACE:
|
||||
cli.log.error('Could not determine QMK userspace location. Please run `qmk doctor` or `qmk userspace-doctor` to diagnose.')
|
||||
return False
|
||||
|
||||
build_env = None if len(cli.args.env) == 0 else parse_env_vars(cli.args.env)
|
||||
|
||||
userspace = UserspaceDefs(QMK_USERSPACE / 'qmk.json')
|
||||
|
||||
if len(cli.args.builds) > 0:
|
||||
|
|
@ -44,8 +48,8 @@ def userspace_add(cli):
|
|||
cli.config.new_keymap.keyboard = cli.args.keyboard
|
||||
cli.config.new_keymap.keymap = cli.args.keymap
|
||||
if new_keymap(cli) is not False:
|
||||
userspace.add_target(keyboard=cli.args.keyboard, keymap=cli.args.keymap)
|
||||
userspace.add_target(keyboard=cli.args.keyboard, keymap=cli.args.keymap, build_env=build_env)
|
||||
else:
|
||||
userspace.add_target(keyboard=cli.args.keyboard, keymap=cli.args.keymap)
|
||||
userspace.add_target(keyboard=cli.args.keyboard, keymap=cli.args.keymap, build_env=build_env)
|
||||
|
||||
return userspace.save()
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Copyright 2023 Nick Brassel (@tzarc)
|
||||
# Copyright 2023-2024 Nick Brassel (@tzarc)
|
||||
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||
from pathlib import Path
|
||||
from milc import cli
|
||||
|
|
@ -12,6 +12,10 @@ from qmk.cli.mass_compile import mass_compile_targets
|
|||
from qmk.util import maybe_exit_config
|
||||
|
||||
|
||||
def _extra_arg_setter(target, extra_args):
|
||||
target.extra_args = extra_args
|
||||
|
||||
|
||||
@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.")
|
||||
|
|
@ -33,8 +37,8 @@ def userspace_compile(cli):
|
|||
if isinstance(e, Path):
|
||||
build_targets.append(JsonKeymapBuildTarget(e))
|
||||
elif isinstance(e, dict):
|
||||
keyboard_keymap_targets.append((e['keyboard'], e['keymap']))
|
||||
|
||||
f = e['env'] if 'env' in e else None
|
||||
keyboard_keymap_targets.append((e['keyboard'], e['keymap'], f))
|
||||
if len(keyboard_keymap_targets) > 0:
|
||||
build_targets.extend(search_keymap_targets(keyboard_keymap_targets))
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Copyright 2023 Nick Brassel (@tzarc)
|
||||
# Copyright 2023-2024 Nick Brassel (@tzarc)
|
||||
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||
from pathlib import Path
|
||||
from dotty_dict import Dotty
|
||||
|
|
@ -13,6 +13,10 @@ from qmk.search import search_keymap_targets
|
|||
from qmk.util import maybe_exit_config
|
||||
|
||||
|
||||
def _extra_arg_setter(target, extra_args):
|
||||
target.extra_args = extra_args
|
||||
|
||||
|
||||
@cli.argument('-e', '--expand', arg_only=True, action='store_true', help="Expands any use of `all` for either keyboard or keymap.")
|
||||
@cli.subcommand('Lists the build targets specified in userspace `qmk.json`.')
|
||||
def userspace_list(cli):
|
||||
|
|
@ -26,11 +30,15 @@ def userspace_list(cli):
|
|||
|
||||
if cli.args.expand:
|
||||
build_targets = []
|
||||
keyboard_keymap_targets = []
|
||||
for e in userspace.build_targets:
|
||||
if isinstance(e, Path):
|
||||
build_targets.append(e)
|
||||
elif isinstance(e, dict) or isinstance(e, Dotty):
|
||||
build_targets.extend(search_keymap_targets([(e['keyboard'], e['keymap'])]))
|
||||
f = e['env'] if 'env' in e else None
|
||||
keyboard_keymap_targets.append((e['keyboard'], e['keymap'], f))
|
||||
if len(keyboard_keymap_targets) > 0:
|
||||
build_targets.extend(search_keymap_targets(keyboard_keymap_targets))
|
||||
else:
|
||||
build_targets = userspace.build_targets
|
||||
|
||||
|
|
@ -43,12 +51,19 @@ def userspace_list(cli):
|
|||
# keyboard/keymap dict from userspace
|
||||
keyboard = e['keyboard']
|
||||
keymap = e['keymap']
|
||||
extra_args = e.get('env')
|
||||
elif isinstance(e, BuildTarget):
|
||||
# BuildTarget from search_keymap_targets()
|
||||
keyboard = e.keyboard
|
||||
keymap = e.keymap
|
||||
extra_args = e.extra_args
|
||||
|
||||
extra_args_str = ''
|
||||
if extra_args is not None and len(extra_args) > 0:
|
||||
extra_args_str = ', '.join([f'{{fg_cyan}}{k}={v}{{fg_reset}}' for k, v in extra_args.items()])
|
||||
extra_args_str = f' ({{fg_cyan}}{extra_args_str}{{fg_reset}})'
|
||||
|
||||
if is_all_keyboards(keyboard) or is_keymap_target(keyboard_folder(keyboard), keymap):
|
||||
cli.log.info(f'Keyboard: {{fg_cyan}}{keyboard}{{fg_reset}}, keymap: {{fg_cyan}}{keymap}{{fg_reset}}')
|
||||
cli.log.info(f'Keyboard: {{fg_cyan}}{keyboard}{{fg_reset}}, keymap: {{fg_cyan}}{keymap}{{fg_reset}}{extra_args_str}')
|
||||
else:
|
||||
cli.log.warn(f'Keyboard: {{fg_cyan}}{keyboard}{{fg_reset}}, keymap: {{fg_cyan}}{keymap}{{fg_reset}} -- not found!')
|
||||
cli.log.warn(f'Keyboard: {{fg_cyan}}{keyboard}{{fg_reset}}, keymap: {{fg_cyan}}{keymap}{{fg_reset}}{extra_args_str} -- not found!')
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
# Copyright 2023 Nick Brassel (@tzarc)
|
||||
# Copyright 2023-2024 Nick Brassel (@tzarc)
|
||||
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||
from pathlib import Path
|
||||
from milc import cli
|
||||
|
||||
from qmk.commands import parse_env_vars
|
||||
from qmk.constants import QMK_USERSPACE, HAS_QMK_USERSPACE
|
||||
from qmk.keyboard import keyboard_completer, keyboard_folder_or_all
|
||||
from qmk.keymap import keymap_completer
|
||||
|
|
@ -12,12 +13,15 @@ from qmk.userspace import UserspaceDefs
|
|||
@cli.argument('builds', nargs='*', arg_only=True, help="List of builds in form <keyboard>:<keymap>, or path to a keymap JSON file.")
|
||||
@cli.argument('-kb', '--keyboard', type=keyboard_folder_or_all, completer=keyboard_completer, help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.')
|
||||
@cli.argument('-km', '--keymap', completer=keymap_completer, help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')
|
||||
@cli.argument('-e', '--env', arg_only=True, action='append', default=[], help="Extra variables to set during build. May be passed multiple times.")
|
||||
@cli.subcommand('Removes a build target from userspace `qmk.json`.')
|
||||
def userspace_remove(cli):
|
||||
if not HAS_QMK_USERSPACE:
|
||||
cli.log.error('Could not determine QMK userspace location. Please run `qmk doctor` or `qmk userspace-doctor` to diagnose.')
|
||||
return False
|
||||
|
||||
build_env = None if len(cli.args.env) == 0 else parse_env_vars(cli.args.env)
|
||||
|
||||
userspace = UserspaceDefs(QMK_USERSPACE / 'qmk.json')
|
||||
|
||||
if len(cli.args.builds) > 0:
|
||||
|
|
@ -29,9 +33,9 @@ def userspace_remove(cli):
|
|||
|
||||
for e in make_like_targets:
|
||||
s = e.split(':')
|
||||
userspace.remove_target(keyboard=s[0], keymap=s[1])
|
||||
userspace.remove_target(keyboard=s[0], keymap=s[1], build_env=build_env)
|
||||
|
||||
else:
|
||||
userspace.remove_target(keyboard=cli.args.keyboard, keymap=cli.args.keymap)
|
||||
userspace.remove_target(keyboard=cli.args.keyboard, keymap=cli.args.keymap, build_env=build_env)
|
||||
|
||||
return userspace.save()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue