Improve LAYOUT macro searching

[fauxpark]

Description

Trying to fix the issue I discovered in #9528 (comment), where the presence of DEFAULT_FOLDER causes qmk info to check there first, even if we are as or more specific.

ie:
qmk info -kb helix -l should search helix.h, then rev2/rev2.h. But if we want helix/rev1 instead, we should search there first, then fall back on DEFAULT_FOLDER, then search everywhere else.

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout/userspace (addition or update)
• Documentation

Issues Fixed or Closed by This PR

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

[skullydazed]

I have some style suggestions below, but they may be moot after we figure out some of the logic changes.

This looks to me like it diverges from make's behavior. Here's how make handles DEFAULT_FOLDER:

    DEFAULT_FOLDER := $$(CURRENT_KB)

    # We assume that every rules.mk will contain the full default value
    $$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/rules.mk)
    ifneq ($$(DEFAULT_FOLDER),$$(CURRENT_KB))
        $$(eval include $(ROOT_DIR)/keyboards/$$(DEFAULT_FOLDER)/rules.mk)
    endif
    CURRENT_KB := $$(DEFAULT_FOLDER)

If DEFAULT_FOLDER is defined at all, not only is it used but it overrides the keyboard name and everything else. I think our basic problem here is (and always has been) that the python logic is treating them as two different boards rather than treating the one with DEFAULT_FOLDER as an alias.

[fauxpark]

I tried to copy that logic here:

but when testing against helix, helix/rev1 and helix/pico the final value is always helix/rev2.

[fauxpark]

Looks like rules_mk() not only parses the rules.mk in the given folder, but also every rules.mk it finds in each part of the path. If DEFAULT_FOLDER is present at any level, it will always be in rules. So this logic won't work.

[fauxpark]

This is working better now - helix prints all the info for helix/rev2, with the exception of Keyboard Folder: helix.

[fauxpark]

I've tested a whole bunch of different boards with all the directory structure combinations I could think of, and apart from the four that error_log is complaining about, qmk info appears to be reporting correctly for all of them.

[fauxpark]

Did a more thorough test, and went through every keyboard listed by make list-keyboards before and after these changes:

--- a
+++ b
@@ -1,15 +1,15 @@
 ☒ keyboards/bpiphany/frosty_flake/frosty_flake.h: LAYOUT_tkl_ansi: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/bpiphany/pegasushoof/2013/2013.h: LAYOUT_tkl_ansi: Nested layout macro detected. Matrix data not available!
+☒ keyboards/bpiphany/pegasushoof/2015/2015.h: LAYOUT_tkl_ansi: Nested layout macro detected. Matrix data not available!
+☒ keyboards/bpiphany/pegasushoof/2015/2015.h: LAYOUT_tkl_iso: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/bpiphany/unloved_bastard/unloved_bastard.h: LAYOUT_tkl_ansi: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/bpiphany/unloved_bastard/unloved_bastard.h: LAYOUT_tkl_iso: Nested layout macro detected. Matrix data not available!
-☒ clueboard/60: Missing LAYOUT() macro for 60_ansi, 60_ansi_split_bs_rshift, 60_iso
 ☒ keyboards/converter/usb_usb/usb_usb.h: LAYOUT_ansi: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/converter/usb_usb/usb_usb.h: LAYOUT_iso: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/converter/usb_usb/usb_usb.h: LAYOUT_jis: Nested layout macro detected. Matrix data not available!
 ⚠ dk60: Falling back to searching for KEYMAP/LAYOUT macros.
 ⚠ efreet: Falling back to searching for KEYMAP/LAYOUT macros.
 ☒ efreet: Missing LAYOUT() macro for ortho_4x12, planck_mit
-☒ ergodash/mini: LAYOUT: Number of elements in info.json does not match! info.json:56 != LAYOUT:70
 ☒ keyboards/exclusive/e65/e65.h: LAYOUT_65_ansi_noblocker: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/exclusive/e65/e65.h: LAYOUT_65_ansi_noblocker_splitbs: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/exclusive/e65/e65.h: LAYOUT_65_iso_noblocker: Nested layout macro detected. Matrix data not available!
@@ -30,36 +30,25 @@
 ☒ keyboards/exclusive/e65/e65.h: LAYOUT_65_iso_7u_hhkb: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/freyr/freyr.h: LAYOUT_tkl_ansi: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/freyr/freyr.h: LAYOUT_tkl_iso: Nested layout macro detected. Matrix data not available!
-☒ handwired/co60/rev6: Missing LAYOUT() macro for 60_ansi, 60_ansi_split_bs_rshift, 60_iso, 60_hhkb
 ⚠ handwired/dactyl_manuform: Falling back to searching for KEYMAP/LAYOUT macros.
 ☒ keyboards/handwired/hnah108/hnah108.h: LAYOUT_fullsize_iso: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/handwired/hnah108/hnah108.h: LAYOUT_fullsize_ansi: Nested layout macro detected. Matrix data not available!
 ⚠ handwired/jtallbean/split_65: Falling back to searching for KEYMAP/LAYOUT macros.
 ⚠ handwired/traveller: Falling back to searching for KEYMAP/LAYOUT macros.
 ⚠ handwired/woodpad: Falling back to searching for KEYMAP/LAYOUT macros.
-☒ helix/pico: LAYOUT: Number of elements in info.json does not match! info.json:50 != LAYOUT:64
-☒ helix/pico/back: LAYOUT: Number of elements in info.json does not match! info.json:50 != LAYOUT:64
-☒ helix/pico/sc: LAYOUT: Number of elements in info.json does not match! info.json:50 != LAYOUT:64
-☒ helix/pico/sc/back: LAYOUT: Number of elements in info.json does not match! info.json:50 != LAYOUT:64
-☒ helix/pico/sc/under: LAYOUT: Number of elements in info.json does not match! info.json:50 != LAYOUT:64
-☒ helix/pico/under: LAYOUT: Number of elements in info.json does not match! info.json:50 != LAYOUT:64
-☒ helix/rev1: LAYOUT: Number of elements in info.json does not match! info.json:60 != LAYOUT:64
 ⚠ jm60: Falling back to searching for KEYMAP/LAYOUT macros.
 ⚠ k_type: Falling back to searching for KEYMAP/LAYOUT macros.
 ☒ keyboards/kbdfans/kbd75/rev1/rev1.h: LAYOUT_75_iso: Nested layout macro detected. Matrix data not available!
+☒ keyboards/kbdfans/kbd75/rev2/rev2.h: LAYOUT_75_iso: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/kc60/kc60.h: LAYOUT: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/keebio/nyquist/nyquist.h: LAYOUT_ortho_4x12: Nested layout macro detected. Matrix data not available!
 ⚠ keycapsss/o4l_5x12: Falling back to searching for KEYMAP/LAYOUT macros.
 ☒ keycapsss/o4l_5x12: Missing LAYOUT() macro for ortho_5x12
-☒ kudox/rev1: LAYOUT: Number of elements in info.json does not match! info.json:64 != LAYOUT:66
 ⚠ lfkeyboards/lfk87: Falling back to searching for KEYMAP/LAYOUT macros.
 ☒ lfkeyboards/lfk87: Missing LAYOUT() macro for tkl_ansi, tkl_iso
 ⚠ lfkeyboards/mini1800: Falling back to searching for KEYMAP/LAYOUT macros.
 ⚠ manta60: Falling back to searching for KEYMAP/LAYOUT macros.
-⚠ meira: Falling back to searching for KEYMAP/LAYOUT macros.
-☒ meira: Missing LAYOUT() macro for ortho_4x12
 ⚠ meira/featherble: Falling back to searching for KEYMAP/LAYOUT macros.
-☒ meira/featherble: Missing LAYOUT() macro for ortho_4x12
 ⚠ meira/promicro: Falling back to searching for KEYMAP/LAYOUT macros.
 ☒ meira/promicro: Missing LAYOUT() macro for ortho_4x12
 ☒ keyboards/phantom/phantom.h: LAYOUT_tkl_ansi: Nested layout macro detected. Matrix data not available!
@@ -67,11 +56,8 @@
 ☒ keyboards/phantom/phantom.h: LAYOUT_tkl_ansi_wkl: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/phantom/phantom.h: LAYOUT_tkl_iso: Nested layout macro detected. Matrix data not available!
 ☒ keyboards/phantom/phantom.h: LAYOUT_tkl_iso_wkl: Nested layout macro detected. Matrix data not available!
-☒ pico/70keys: LAYOUT: Number of elements in info.json does not match! info.json:70 != LAYOUT:65
 ⚠ pimentoso/paddino02: Falling back to searching for KEYMAP/LAYOUT macros.
 ☒ keyboards/planck/ez/ez.h: LAYOUT_ortho_4x12: Nested layout macro detected. Matrix data not available!
-⚠ rgbkb/zen: Falling back to searching for KEYMAP/LAYOUT macros.
-⚠ rgbkb/zen/rev1: Falling back to searching for KEYMAP/LAYOUT macros.
 ⚠ rgbkb/zen/rev2: Falling back to searching for KEYMAP/LAYOUT macros.
 ⚠ sirius/uni660: Falling back to searching for KEYMAP/LAYOUT macros.
 ☒ keyboards/sirius/unigo66/unigo66.h: LAYOUT: Nested layout macro detected. Matrix data not available!

[noroadsleft]

Looks good to me.

[drashna]

__attribute__((weak)) ✅