From ffdc70bf0a6fecff024ece2a5b7b4c0c88dd6ee3 Mon Sep 17 00:00:00 2001
From: Nick Brassel <nick@tzarc.org>
Date: Wed, 21 Jun 2023 08:41:49 +1000
Subject: Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT`
 (#21272)

---
 lib/python/qmk/cli/mass_compile.py | 17 +++++++++--------
 lib/python/qmk/commands.py         | 26 +++++++++++---------------
 lib/python/qmk/constants.py        |  2 +-
 3 files changed, 21 insertions(+), 24 deletions(-)

(limited to 'lib')

diff --git a/lib/python/qmk/cli/mass_compile.py b/lib/python/qmk/cli/mass_compile.py
index 52c1cae4c2..ddd946a32b 100755
--- a/lib/python/qmk/cli/mass_compile.py
+++ b/lib/python/qmk/cli/mass_compile.py
@@ -53,20 +53,22 @@ def mass_compile(cli):
             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}"
             # yapf: disable
             f.write(
                 f"""\
 all: {keyboard_safe}_{keymap_name}_binary
 {keyboard_safe}_{keymap_name}_binary:
-	@rm -f "{QMK_FIRMWARE}/.build/failed.log.{keyboard_safe}.{keymap_name}" || true
-	@echo "Compiling QMK Firmware for target: '{keyboard_name}:{keymap_name}'..." >>"{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}"
+	@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)} \\
-		>>"{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" 2>&1 \\
-		|| cp "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" "{QMK_FIRMWARE}/.build/failed.log.{os.getpid()}.{keyboard_safe}.{keymap_name}"
-	@{{ grep '\[ERRORS\]' "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" >/dev/null 2>&1 && printf "Build %-64s \e[1;31m[ERRORS]\e[0m\\n" "{keyboard_name}:{keymap_name}" ; }} \\
-		|| {{ grep '\[WARNINGS\]' "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" >/dev/null 2>&1 && printf "Build %-64s \e[1;33m[WARNINGS]\e[0m\\n" "{keyboard_name}:{keymap_name}" ; }} \\
+		>>"{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 "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" || true
+	@rm -f "{build_log}" || true
 """# noqa
             )
             # yapf: enable
@@ -77,7 +79,6 @@ all: {keyboard_safe}_{keymap_name}_binary
                     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}" || true
 	@rm -rf "{QMK_FIRMWARE}/.build/obj_{keyboard_safe}_{keymap_name}" || true
 """# noqa
                 )
diff --git a/lib/python/qmk/commands.py b/lib/python/qmk/commands.py
index b1eac13957..ab8e323edf 100644
--- a/lib/python/qmk/commands.py
+++ b/lib/python/qmk/commands.py
@@ -9,7 +9,7 @@ from pathlib import Path
 from milc import cli
 import jsonschema
 
-from qmk.constants import KEYBOARD_OUTPUT_PREFIX
+from qmk.constants import INTERMEDIATE_OUTPUT_PREFIX
 from qmk.json_schema import json_load, validate
 
 
@@ -134,16 +134,13 @@ def compile_configurator_json(user_keymap, bootloader=None, parallel=1, clean=Fa
 
     keyboard_filesafe = user_keymap['keyboard'].replace('/', '_')
     target = f'{keyboard_filesafe}_{user_keymap["keymap"]}'
-    keyboard_output = Path(f'{KEYBOARD_OUTPUT_PREFIX}{keyboard_filesafe}')
-    keymap_output = Path(f'{keyboard_output}_{user_keymap["keymap"]}')
-    keymap_dir = keymap_output / 'src'
+    intermediate_output = Path(f'{INTERMEDIATE_OUTPUT_PREFIX}{keyboard_filesafe}_{user_keymap["keymap"]}')
+    keymap_dir = intermediate_output / 'src'
     keymap_json = keymap_dir / 'keymap.json'
 
     if clean:
-        if keyboard_output.exists():
-            shutil.rmtree(keyboard_output)
-        if keymap_output.exists():
-            shutil.rmtree(keymap_output)
+        if intermediate_output.exists():
+            shutil.rmtree(intermediate_output)
 
     # begin with making the deepest folder in the tree
     keymap_dir.mkdir(exist_ok=True, parents=True)
@@ -183,13 +180,12 @@ def compile_configurator_json(user_keymap, bootloader=None, parallel=1, clean=Fa
         f'KEYMAP={user_keymap["keymap"]}',
         f'KEYBOARD_FILESAFE={keyboard_filesafe}',
         f'TARGET={target}',
-        f'KEYBOARD_OUTPUT={keyboard_output}',
-        f'KEYMAP_OUTPUT={keymap_output}',
-        f'MAIN_KEYMAP_PATH_1={keymap_output}',
-        f'MAIN_KEYMAP_PATH_2={keymap_output}',
-        f'MAIN_KEYMAP_PATH_3={keymap_output}',
-        f'MAIN_KEYMAP_PATH_4={keymap_output}',
-        f'MAIN_KEYMAP_PATH_5={keymap_output}',
+        f'INTERMEDIATE_OUTPUT={intermediate_output}',
+        f'MAIN_KEYMAP_PATH_1={intermediate_output}',
+        f'MAIN_KEYMAP_PATH_2={intermediate_output}',
+        f'MAIN_KEYMAP_PATH_3={intermediate_output}',
+        f'MAIN_KEYMAP_PATH_4={intermediate_output}',
+        f'MAIN_KEYMAP_PATH_5={intermediate_output}',
         f'KEYMAP_JSON={keymap_json}',
         f'KEYMAP_PATH={keymap_dir}',
         f'VERBOSE={verbose}',
diff --git a/lib/python/qmk/constants.py b/lib/python/qmk/constants.py
index 8a13029a8a..04ec4f6a16 100644
--- a/lib/python/qmk/constants.py
+++ b/lib/python/qmk/constants.py
@@ -123,7 +123,7 @@ ROW_LETTERS = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnop'
 
 # Constants that should match their counterparts in make
 BUILD_DIR = environ.get('BUILD_DIR', '.build')
-KEYBOARD_OUTPUT_PREFIX = f'{BUILD_DIR}/obj_'
+INTERMEDIATE_OUTPUT_PREFIX = f'{BUILD_DIR}/obj_'
 
 # Headers for generated files
 GPL2_HEADER_C_LIKE = f'''\
-- 
cgit v1.2.3