5 # Never run this makefile in parallel, as it could screw things up
6 # It won't affect the submakes, so you still get the speedup from specifying -jx
9 # Allow the silent with lower caps to work the same way as upper caps
15 SUB_IS_SILENT
:= $(SILENT
)
18 # We need to make sure that silent is always turned off at the top level
19 # Otherwise the [OK], [ERROR] and [WARN] messages won't be displayed correctly
20 override SILENT
:= false
22 ON_ERROR
:= error_occurred
=1
26 STARTING_MAKEFILE
:= $(firstword $(MAKEFILE_LIST
))
27 ROOT_MAKEFILE
:= $(lastword
$(MAKEFILE_LIST
))
28 ROOT_DIR
:= $(dir $(ROOT_MAKEFILE
))
32 ABS_STARTING_MAKEFILE
:= $(abspath
$(STARTING_MAKEFILE
))
33 ABS_ROOT_MAKEFILE
:= $(abspath
$(ROOT_MAKEFILE
))
34 ABS_STARTING_DIR
:= $(dir $(ABS_STARTING_MAKEFILE
))
35 ABS_ROOT_DIR
:= $(dir $(ABS_ROOT_MAKEFILE
))
36 STARTING_DIR
:= $(subst $(ABS_ROOT_DIR
),,$(ABS_STARTING_DIR
))
37 BUILD_DIR
:= $(ROOT_DIR
)/.build
38 TEST_DIR
:= $(BUILD_DIR
)/test
39 ERROR_FILE
:= $(BUILD_DIR
)/error_occurred
43 # Helper function to process the newt element of a space separated path
44 # It works a bit like the traditional functional head tail
45 # so the CURRENT_PATH_ELEMENT will become the new head
46 # and the PATH_ELEMENTS are the rest that are still unprocessed
47 define NEXT_PATH_ELEMENT
48 $$(eval CURRENT_PATH_ELEMENT
:= $$(firstword $$(PATH_ELEMENTS
)))
49 $$(eval PATH_ELEMENTS
:= $$(wordlist
2,9999,$$(PATH_ELEMENTS
)))
52 # We change the / to spaces so that we more easily can work with the elements
54 PATH_ELEMENTS
:= $(subst /, ,$(STARTING_DIR
))
55 # Initialize the path elements list for further processing
56 $(eval
$(call NEXT_PATH_ELEMENT
))
58 # This function sets the KEYBOARD; KEYMAP and SUBPROJECT to the correct
59 # variables depending on which directory you stand in.
60 # It's really a very simple if else chain, if you squint enough,
61 # but the makefile syntax makes it very verbose.
62 # If we are in a subfolder of keyboards
63 ifeq ($(CURRENT_PATH_ELEMENT
),keyboards
)
64 $(eval
$(call NEXT_PATH_ELEMENT
))
65 KEYBOARD
:= $(CURRENT_PATH_ELEMENT
)
66 $(eval
$(call NEXT_PATH_ELEMENT
))
67 # If we are in a subfolder of keymaps, or in other words in a keymap
69 ifeq ($(CURRENT_PATH_ELEMENT
),keymaps
)
70 $(eval
$(call NEXT_PATH_ELEMENT
))
71 KEYMAP
:= $(CURRENT_PATH_ELEMENT
)
72 # else if we are not in the keyboard folder itself
73 else ifneq ($(CURRENT_PATH_ELEMENT
),)
74 # the we can assume it's a subproject, as no other folders
75 # should have make files in them
76 SUBPROJECT
:= $(CURRENT_PATH_ELEMENT
)
77 $(eval
$(call NEXT_PATH_ELEMENT
))
78 # if we are inside a keymap folder of a subproject
79 ifeq ($(CURRENT_PATH_ELEMENT
),keymaps
)
80 $(eval
$(call NEXT_PATH_ELEMENT
))
81 KEYMAP
:= $(CURRENT_PATH_ELEMENT
)
86 # Only consider folders with makefiles, to prevent errors in case there are extra folders
87 KEYBOARDS
:= $(notdir $(patsubst %/Makefile
,%,$(wildcard $(ROOT_DIR
)/keyboards
/*/Makefile
)))
89 #Compatibility with the old make variables, anything you specify directly on the command line
90 # always overrides the detected folders
92 KEYBOARD
:= $(keyboard
)
98 SUBPROJECT
:= $(subproject
)
104 # Uncomment these for debugging
105 #$(info Keyboard: $(KEYBOARD))
106 #$(info Keymap: $(KEYMAP))
107 #$(info Subproject: $(SUBPROJECT))
108 #$(info Keyboards: $(KEYBOARDS))
111 # Set the default goal depending on where we are running make from
112 # this handles the case where you run make without any arguments
115 ifeq ($(SUBPROJECT
),)
116 # Inside a keymap folder, just build the keymap, with the
118 .DEFAULT_GOAL
:= $(KEYBOARD
)-$(KEYMAP
)
120 # Inside a subproject keyamp folder, build the keymap
121 # for that subproject
122 .DEFAULT_GOAL
:= $(KEYBOARD
)-$(SUBPROJECT
)-$(KEYMAP
)
124 else ifneq ($(SUBPROJECT
),)
125 # Inside a subproject folder, build all keymaps for that subproject
126 .DEFAULT_GOAL
:= $(KEYBOARD
)-$(SUBPROJECT
)-allkm
127 else ifneq ($(KEYBOARD
),)
128 # Inside a keyboard folder, build all keymaps for all subprojects
129 # Note that this is different from the old behaviour, which would
130 # build only the default keymap of the default keyboard
131 .DEFAULT_GOAL
:= $(KEYBOARD
)-allsp-allkm
135 # Compare the start of the RULE variable with the first argument($1)
136 # If the rules equals $1 or starts with $1-, RULE_FOUND is set to true
137 # and $1 is removed from the RULE variable
138 # Otherwise the RULE_FOUND variable is set to false, and RULE left as it was
139 # The function is a bit tricky, since there's no built in $(startswith) function
140 define COMPARE_AND_REMOVE_FROM_RULE_HELPER
145 STARTDASH_REMOVED
=$$(subst START
$1-,,START
$$(RULE
))
146 ifneq ($$(STARTDASH_REMOVED
),START
$$(RULE
))
148 RULE
:= $$(STARTDASH_REMOVED
)
155 # This makes it easier to call COMPARE_AND_REMOVE_FROM_RULE, since it makes it behave like
156 # a function that returns the value
157 COMPARE_AND_REMOVE_FROM_RULE
= $(eval
$(call COMPARE_AND_REMOVE_FROM_RULE_HELPER
,$1))$(RULE_FOUND
)
160 # Recursively try to find a match for the start of the rule to be checked
161 # $1 The list to be checked
162 # If a match is found, then RULE_FOUND is set to true
163 # and MATCHED_ITEM to the item that was matched
164 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
166 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,$$(firstword $1)),true
)
167 MATCHED_ITEM
:= $$(firstword $1)
169 $$(eval
$$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
,$$(wordlist
2,9999,$1)))
174 # A recursive helper function for finding the longest match
175 # $1 The list to be checked
176 # It works by always removing the currently matched item from the list
177 # and call itself recursively, until a match is found
178 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
179 # Stop the recursion when the list is empty
181 RULE_BEFORE
:= $$(RULE
)
182 $$(eval
$$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
,$1))
183 # If a match is found in the current list, otherwise just return what we had before
184 ifeq ($$(RULE_FOUND
),true
)
185 # Save the best match so far and call itself recursively
186 BEST_MATCH
:= $$(MATCHED_ITEM
)
187 BEST_MATCH_RULE
:= $$(RULE
)
189 RULE
:= $$(RULE_BEFORE
)
190 $$(eval
$$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
,$$(filter-out $$(MATCHED_ITEM
),$1)))
196 # Recursively try to find the longest match for the start of the rule to be checked
197 # $1 The list to be checked
198 # If a match is found, then RULE_FOUND is set to true
199 # and MATCHED_ITEM to the item that was matched
200 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER
202 $$(eval
$$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
,$1))
203 ifneq ($$(BEST_MATCH
),)
205 RULE
:= $$(BEST_MATCH_RULE
)
206 MATCHED_ITEM
:= $$(BEST_MATCH
)
213 # Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
214 TRY_TO_MATCH_RULE_FROM_LIST
= $(eval
$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER
,$1))$(RULE_FOUND
)
216 define ALL_IN_LIST_LOOP
217 OLD_RULE
$1 := $$(RULE
)
218 $$(eval
$$(call
$1,$$(ITEM
$1)))
219 RULE
:= $$(OLD_RULE
$1)
222 define PARSE_ALL_IN_LIST
223 $$(foreach ITEM
$1,$2,$$(eval
$$(call ALL_IN_LIST_LOOP
,$1)))
226 # The entry point for rule parsing
227 # parses a rule in the format <keyboard>-<subproject>-<keymap>-<target>
228 # but this particular function only deals with the first <keyboard> part
232 # If the rule starts with allkb, then continue the parsing from
233 # PARSE_ALL_KEYBOARDS
234 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,allkb
),true
)
235 $$(eval
$$(call PARSE_ALL_KEYBOARDS
))
236 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,test),true
)
237 $$(eval
$$(call PARSE_TEST
))
238 # If the rule starts with the name of a known keyboard, then continue
239 # the parsing from PARSE_KEYBOARD
240 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST
,$$(KEYBOARDS
)),true
)
241 $$(eval
$$(call PARSE_KEYBOARD
,$$(MATCHED_ITEM
)))
242 # Otherwise use the KEYBOARD variable, which is determined either by
243 # the current directory you run make from, or passed in as an argument
244 else ifneq ($$(KEYBOARD
),)
245 $$(eval
$$(call PARSE_KEYBOARD
,$$(KEYBOARD
)))
247 $$(info make
: *** No rule to make target
'$1'. Stop.
)
248 # Notice the tab instead of spaces below!
254 # Parses a rule in the format <subproject>-<keymap>-<target>
255 # the keyboard is already known when entering this function
256 define PARSE_KEYBOARD
258 # A subproject is any keyboard subfolder with a makefile
259 SUBPROJECTS
:= $$(notdir $$(patsubst %/Makefile
,%,$$(wildcard $(ROOT_DIR
)/keyboards
/$$(CURRENT_KB
)/*/Makefile
)))
260 # if the rule starts with allsp, then continue with looping over all subprojects
261 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,allsp
),true
)
262 $$(eval
$$(call PARSE_ALL_SUBPROJECTS
))
263 # A special case for matching the defaultsp (default subproject)
264 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,defaultsp
),true
)
265 $$(eval
$$(call PARSE_SUBPROJECT
,defaultsp
))
266 # If the rule starts with the name of a known subproject
267 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST
,$$(SUBPROJECTS
)),true
)
268 $$(eval
$$(call PARSE_SUBPROJECT
,$$(MATCHED_ITEM
)))
269 # Try to use the SUBPROJECT variable, which is either determined by the
270 # directory which invoked make, or passed as an argument to make
271 else ifneq ($$(SUBPROJECT
),)
272 $$(eval
$$(call PARSE_SUBPROJECT
,$$(SUBPROJECT
)))
273 # If there's no matching subproject, we assume it's the default
274 # This will allow you to leave the subproject part of the target out
276 $$(eval
$$(call PARSE_SUBPROJECT
,))
280 # if we are going to compile all keyboards, match the rest of the rule
282 define PARSE_ALL_KEYBOARDS
283 $$(eval
$$(call PARSE_ALL_IN_LIST
,PARSE_KEYBOARD
,$(KEYBOARDS
)))
287 # When entering this, the keyboard and subproject are known, so now we need
288 # to determine which keymaps are going to get compiled
289 define PARSE_SUBPROJECT
290 # If we want to compile the default subproject, then we need to
291 # include the correct makefile to determine the actual name of it
293 ifeq ($$(CURRENT_SP
),)
294 CURRENT_SP
:= defaultsp
296 ifeq ($$(CURRENT_SP
),defaultsp
)
298 $$(eval
include $(ROOT_DIR
)/keyboards
/$$(CURRENT_KB
)/Makefile
)
299 CURRENT_SP
:= $$(SUBPROJECT_DEFAULT
)
301 # If current subproject is empty (the default was not defined), and we have a list of subproject
302 # then make all of them
303 ifeq ($$(CURRENT_SP
),)
304 ifneq ($$(SUBPROJECTS
),)
308 # The special allsp is handled later
309 ifneq ($$(CURRENT_SP
),allsp
)
310 # get a list of all keymaps
311 KEYMAPS
:= $$(notdir $$(patsubst %/.
,%,$$(wildcard $(ROOT_DIR
)/keyboards
/$$(CURRENT_KB
)/keymaps
/*/.
)))
312 ifneq ($$(CURRENT_SP
),)
313 # if the subproject is defined, then also look for keymaps inside the subproject folder
314 SP_KEYMAPS
:= $$(notdir $$(patsubst %/.
,%,$$(wildcard $(ROOT_DIR
)/keyboards
/$$(CURRENT_KB
)/$$(CURRENT_SP
)/keymaps
/*/.
)))
315 KEYMAPS
:= $$(sort $$(KEYMAPS
) $$(SP_KEYMAPS
))
317 # if the rule after removing the start of it is empty (we haven't specified a kemap or target)
318 # compile all the keymaps
320 $$(eval
$$(call PARSE_ALL_KEYMAPS
))
321 # The same if allkm was specified
322 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,allkm
),true
)
323 $$(eval
$$(call PARSE_ALL_KEYMAPS
))
324 # Try to match the specified keyamp with the list of known keymaps
325 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST
,$$(KEYMAPS
)),true
)
326 $$(eval
$$(call PARSE_KEYMAP
,$$(MATCHED_ITEM
)))
327 # Otherwise try to match the keymap from the current folder, or arguments to the make command
328 else ifneq ($$(KEYMAP
),)
329 $$(eval
$$(call PARSE_KEYMAP
,$$(KEYMAP
)))
330 # No matching keymap found, so we assume that the rest of the rule is the target
331 # If we haven't been able to parse out a subproject, then make all of them
332 # This is consistent with running make without any arguments from the keyboard
335 $$(eval
$$(call PARSE_ALL_SUBPROJECTS
))
336 # Otherwise, make all keymaps, again this is consistent with how it works without
339 $$(eval
$$(call PARSE_ALL_KEYMAPS
))
342 # As earlier mentioned when allsb is specified, we call our self recursively
343 # for all of the subprojects
344 $$(eval
$$(call PARSE_ALL_IN_LIST
,PARSE_SUBPROJECT
,$(SUBPROJECTS
)))
348 # If we want to parse all subprojects, but the keyboard doesn't have any,
349 # then use defaultsp instead
350 define PARSE_ALL_SUBPROJECTS
351 ifeq ($$(SUBPROJECTS
),)
352 $$(eval
$$(call PARSE_SUBPROJECT
,defaultsp
))
354 $$(eval
$$(call PARSE_ALL_IN_LIST
,PARSE_SUBPROJECT
,$$(SUBPROJECTS
)))
359 # This is the meat of compiling a keyboard, when entering this, everything is known
360 # keyboard, subproject, and keymap
361 # Note that we are not directly calling the command here, but instead building a list,
362 # which will later be processed
365 # The rest of the rule is the target
366 # Remove the leading "-" from the target, as it acts as a separator
367 MAKE_TARGET
:= $$(patsubst -%,%,$$(RULE
))
368 # We need to generate an unique indentifer to append to the COMMANDS list
369 COMMAND
:= COMMAND_KEYBOARD_
$$(CURRENT_KB
)_SUBPROJECT_
$(CURRENT_SP
)_KEYMAP_
$$(CURRENT_KM
)
370 # If we are compiling a keyboard without a subproject, we want to display just the name
371 # of the keyboard, otherwise keyboard/subproject
372 ifeq ($$(CURRENT_SP
),)
373 KB_SP
:= $(CURRENT_KB
)
375 KB_SP
:= $(CURRENT_KB
)/$$(CURRENT_SP
)
378 KB_SP
:= $(BOLD
)$$(KB_SP
)$(NO_COLOR
)
379 # Specify the variables that we are passing forward to submake
380 MAKE_VARS
:= KEYBOARD
=$$(CURRENT_KB
) SUBPROJECT
=$$(CURRENT_SP
) KEYMAP
=$$(CURRENT_KM
)
381 # And the first part of the make command
382 MAKE_CMD
:= $$(MAKE
) -r
-R
-C
$(ROOT_DIR
) -f build_keyboard.mk
$$(MAKE_TARGET
)
383 # The message to display
384 MAKE_MSG
:= $$(MSG_MAKE_KB
)
385 # We run the command differently, depending on if we want more output or not
386 # The true version for silent output and the false version otherwise
387 $$(eval
$$(call BUILD
))
391 MAKE_VARS
+= VERBOSE
=$(VERBOSE
) COLOR
=$(COLOR
)
392 COMMANDS
+= $$(COMMAND
)
393 COMMAND_true_
$$(COMMAND
) := \
394 printf
"$$(MAKE_MSG)" | \
395 $$(MAKE_MSG_FORMAT
); \
396 LOG
=$$$$($$(MAKE_CMD
) $$(MAKE_VARS
) SILENT
=true
2>&1) ; \
397 if
[ $$$$?
-gt
0 ]; \
398 then
$$(PRINT_ERROR_PLAIN
); \
399 elif
[ "$$$$LOG" != "" ] ; \
400 then
$$(PRINT_WARNING_PLAIN
); \
404 COMMAND_false_
$$(COMMAND
) := \
405 printf
"$$(MAKE_MSG)\n\n"; \
406 $$(MAKE_CMD
) $$(MAKE_VARS
) SILENT
=false
; \
407 if
[ $$$$?
-gt
0 ]; \
408 then error_occurred
=1; \
412 # Just parse all the keymaps for a specific keyboard
413 define PARSE_ALL_KEYMAPS
414 $$(eval
$$(call PARSE_ALL_IN_LIST
,PARSE_KEYMAP
,$$(KEYMAPS
)))
421 MAKE_CMD
:= $$(MAKE
) -r
-R
-C
$(ROOT_DIR
) -f build_test.mk
$$(MAKE_TARGET
)
422 MAKE_VARS
:= TEST
=$$(TEST_NAME
) FULL_TESTS
=$$(FULL_TESTS
)
423 MAKE_MSG
:= $$(MSG_MAKE_TEST
)
424 $$(eval
$$(call BUILD
))
425 ifneq ($$(MAKE_TARGET
),clean)
426 TEST_EXECUTABLE
:= $$(TEST_DIR
)/$$(TEST_NAME
).elf
427 TESTS
+= $$(TEST_NAME
)
428 TEST_MSG
:= $$(MSG_TEST
)
429 $$(TEST_NAME
)_COMMAND
:= \
430 printf
"$$(TEST_MSG)\n"; \
431 $$(TEST_EXECUTABLE
); \
432 if
[ $$$$?
-gt
0 ]; \
433 then error_occurred
=1; \
441 TEST_NAME
:= $$(firstword $$(subst -, ,$$(RULE
)))
442 TEST_TARGET
:= $$(subst $$(TEST_NAME
),,$$(subst $$(TEST_NAME
)-,,$$(RULE
)))
443 ifeq ($$(TEST_NAME
),all)
444 MATCHED_TESTS
:= $$(TEST_LIST
)
446 MATCHED_TESTS
:= $$(foreach TEST
,$$(TEST_LIST
),$$(if
$$(findstring $$(TEST_NAME
),$$(TEST
)),$$(TEST
),))
448 $$(foreach TEST
,$$(MATCHED_TESTS
),$$(eval
$$(call BUILD_TEST
,$$(TEST
),$$(TEST_TARGET
))))
452 # Set the silent mode depending on if we are trying to compile multiple keyboards or not
453 # By default it's on in that case, but it can be overridden by specifying silent=false
454 # from the command line
455 define SET_SILENT_MODE
457 SILENT_MODE
:= $(SUB_IS_SILENT
)
458 else ifeq ($$(words $$(COMMANDS
)),1)
465 include $(ROOT_DIR
)/message.mk
467 ifeq ($(strip $(BREAK_ON_ERRORS
)), yes
)
468 HANDLE_ERROR
= exit
1
470 HANDLE_ERROR
= echo
$$error_occurred > $(ERROR_FILE
)
473 # The empty line is important here, as it will force a new shell to be created for each command
474 # Otherwise the command line will become too long with a lot of keyboards and keymaps
477 $(COMMAND_
$(SILENT_MODE
)_
$(COMMAND
))\
478 if
[ $$error_occurred -gt
0 ]; then
$(HANDLE_ERROR
); fi
;
485 if
[ $$error_occurred -gt
0 ]; then
$(HANDLE_ERROR
); fi
;
488 # Allow specifying just the subproject, in the keyboard directory, which will compile all keymaps
489 SUBPROJECTS
:= $(notdir $(patsubst %/Makefile
,%,$(wildcard .
/*/Makefile
)))
490 .PHONY
: $(SUBPROJECTS
)
491 $(SUBPROJECTS
): %: %-allkm
493 # Let's match everything, we handle all the rule parsing ourselves
496 # Check if we have the CMP tool installed
497 cmp
$(ROOT_DIR
)/Makefile
$(ROOT_DIR
)/Makefile
>/dev
/null
2>&1; if
[ $$?
-gt
0 ]; then printf
"$(MSG_NO_CMP)"; exit
1; fi
;
498 # Check if the submodules are dirty, and display a warning if they are
500 git submodule status
--recursive
2>/dev
/null | \
501 while IFS
= read
-r x
; do \
504 *) printf
"$(MSG_SUBMODULE_DIRTY)";break
;; \
508 rm -f
$(ERROR_FILE
) > /dev
/null
2>&1
509 $(eval
$(call PARSE_RULE
,$@
))
510 $(eval
$(call SET_SILENT_MODE
))
511 # Run all the commands in the same shell, notice the + at the first line
512 # it has to be there to allow parallel execution of the submake
513 # This always tries to compile everything, even if error occurs in the middle
514 # But we return the error code at the end, to trigger travis failures
515 $(foreach COMMAND
,$(COMMANDS
),$(RUN_COMMAND
))
516 if
[ -f
$(ERROR_FILE
) ]; then printf
"$(MSG_ERRORS)" & exit
1; fi
;
517 $(foreach TEST
,$(TESTS
),$(RUN_TEST
))
518 if
[ -f
$(ERROR_FILE
) ]; then printf
"$(MSG_ERRORS)" & exit
1; fi
;
520 # All should compile everything
522 all: all-keyboards test-all
524 # Define some shortcuts, mostly for compatibility with the old syntax
525 .PHONY
: all-keyboards
526 all-keyboards
: allkb-allsp-allkm
528 .PHONY
: all-keyboards-defaults
529 all-keyboards-defaults
: allkb-allsp-default
535 test-clean
: test-all-clean
541 # Generate the version.h file
543 GIT_VERSION
:= $(shell git describe
--abbrev
=6 --dirty
--always
--tags 2>/dev
/null || date
+"%Y-%m-%d-%H:%M:%S")
548 BUILD_DATE
:= $(shell date
+"%Y-%m-%d-%H:%M:%S")
549 $(shell echo
'#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR
)/quantum
/version.h
)
550 $(shell echo
'#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR
)/quantum
/version.h
)
555 include $(ROOT_DIR
)/testlist.mk