]> git.donarmstrong.com Git - qmk_firmware.git/blob - Makefile
Disable the glossary linking to fix #2498 (#2499)
[qmk_firmware.git] / Makefile
1 ifndef VERBOSE
2 .SILENT:
3 endif
4
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
7 .NOTPARALLEL:
8
9 # Allow the silent with lower caps to work the same way as upper caps
10 ifdef silent
11     SILENT = $(silent)
12 endif
13
14 ifdef SILENT
15     SUB_IS_SILENT := $(SILENT)
16 endif
17
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
21
22 ifndef SUB_IS_SILENT
23 QMK_VERSION := $(shell git describe --abbrev=0 --tags 2>/dev/null)
24 ifneq ($(QMK_VERSION),)
25 $(info QMK Firmware $(QMK_VERSION))
26 endif
27 endif
28
29 ON_ERROR := error_occurred=1
30
31 BREAK_ON_ERRORS = no
32
33 STARTING_MAKEFILE := $(firstword $(MAKEFILE_LIST))
34 ROOT_MAKEFILE := $(lastword $(MAKEFILE_LIST))
35 ROOT_DIR := $(dir $(ROOT_MAKEFILE))
36 ifeq ($(ROOT_DIR),)
37     ROOT_DIR := .
38 endif
39 ABS_STARTING_MAKEFILE := $(abspath $(STARTING_MAKEFILE))
40 ABS_ROOT_MAKEFILE := $(abspath $(ROOT_MAKEFILE))
41 ABS_STARTING_DIR := $(dir $(ABS_STARTING_MAKEFILE))
42 ABS_ROOT_DIR := $(dir $(ABS_ROOT_MAKEFILE))
43 STARTING_DIR := $(subst $(ABS_ROOT_DIR),,$(ABS_STARTING_DIR))
44 BUILD_DIR := $(ROOT_DIR)/.build
45 TEST_DIR := $(BUILD_DIR)/test
46 ERROR_FILE := $(BUILD_DIR)/error_occurred
47
48 MAKEFILE_INCLUDED=yes
49
50 # Helper function to process the newt element of a space separated path
51 # It works a bit like the traditional functional head tail
52 # so the CURRENT_PATH_ELEMENT will become the new head
53 # and the PATH_ELEMENTS are the rest that are still unprocessed
54 define NEXT_PATH_ELEMENT
55     $$(eval CURRENT_PATH_ELEMENT := $$(firstword  $$(PATH_ELEMENTS)))
56     $$(eval PATH_ELEMENTS := $$(wordlist  2,9999,$$(PATH_ELEMENTS)))
57 endef
58
59 # We change the / to spaces so that we more easily can work with the elements
60 # separately
61 PATH_ELEMENTS := $(subst /, ,$(STARTING_DIR))
62 # Initialize the path elements list for further processing
63 $(eval $(call NEXT_PATH_ELEMENT))
64
65 # This function sets the KEYBOARD; KEYMAP and SUBPROJECT to the correct
66 # variables depending on which directory you stand in.
67 # It's really a very simple if else chain, if you squint enough,
68 # but the makefile syntax makes it very verbose.
69 # If we are in a subfolder of keyboards
70
71 # *** No longer needed **
72 #
73 # ifeq ($(CURRENT_PATH_ELEMENT),keyboards)
74 #     $(eval $(call NEXT_PATH_ELEMENT))
75 #     KEYBOARD := $(CURRENT_PATH_ELEMENT)
76 #     $(eval $(call NEXT_PATH_ELEMENT))
77 #     # If we are in a subfolder of keymaps, or in other words in a keymap
78 #     # folder
79 #     ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
80 #         $(eval $(call NEXT_PATH_ELEMENT))
81 #         KEYMAP := $(CURRENT_PATH_ELEMENT)
82 #      # else if we are not in the keyboard folder itself
83 #     else ifneq ($(CURRENT_PATH_ELEMENT),)
84 #         # the we can assume it's a subproject, as no other folders
85 #         # should have make files in them
86 #         SUBPROJECT := $(CURRENT_PATH_ELEMENT)
87 #         $(eval $(call NEXT_PATH_ELEMENT))
88 #         # if we are inside a keymap folder of a subproject
89 #         ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
90 #             $(eval $(call NEXT_PATH_ELEMENT))
91 #             KEYMAP := $(CURRENT_PATH_ELEMENT)
92 #         endif
93 #     endif
94 # endif
95
96 define GET_KEYBOARDS
97     All_RULES_MK := $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/rules.mk))
98     All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/rules.mk))
99     All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/rules.mk))
100     All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/*/rules.mk))
101
102     KEYMAPS_MK := $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/keymaps/*/rules.mk))
103     KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/keymaps/*/rules.mk))
104     KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/keymaps/*/rules.mk))
105     KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/*/keymaps/*/rules.mk))
106
107     KEYBOARDS := $$(sort $$(filter-out $$(KEYMAPS_MK), $$(All_RULES_MK)))
108 endef
109
110 $(eval $(call GET_KEYBOARDS))
111
112 # Only consider folders with makefiles, to prevent errors in case there are extra folders
113 #KEYBOARDS += $(patsubst $(ROOD_DIR)/keyboards/%/rules.mk,%,$(wildcard $(ROOT_DIR)/keyboards/*/*/rules.mk))
114
115 list-keyboards:
116         echo $(KEYBOARDS)
117         exit 0
118
119 define PRINT_KEYBOARD
120         $(info $(PRINTING_KEYBOARD))
121 endef
122
123 generate-keyboards-file:
124         $(foreach PRINTING_KEYBOARD,$(KEYBOARDS),$(eval $(call PRINT_KEYBOARD)))
125         exit 0
126
127 #Compatibility with the old make variables, anything you specify directly on the command line
128 # always overrides the detected folders
129 ifdef keyboard
130     KEYBOARD := $(keyboard)
131 endif
132 ifdef keymap
133     KEYMAP := $(keymap)
134 endif
135
136 # Uncomment these for debugging
137 # $(info Keyboard: $(KEYBOARD))
138 # $(info Keymap: $(KEYMAP))
139 # $(info Subproject: $(SUBPROJECT))
140 # $(info Keyboards: $(KEYBOARDS))
141
142
143 # Set the default goal depending on where we are running make from
144 # this handles the case where you run make without any arguments
145 .DEFAULT_GOAL := all:all
146 ifneq ($(KEYMAP),)
147     .DEFAULT_GOAL := $(KEYBOARD):$(KEYMAP)
148 else ifneq ($(KEYBOARD),)
149      # Inside a keyboard folder, build all keymaps for all subprojects
150      # Note that this is different from the old behaviour, which would
151      # build only the default keymap of the default keyboard
152     .DEFAULT_GOAL := $(KEYBOARD):all
153 endif
154
155
156 # Compare the start of the RULE variable with the first argument($1)
157 # If the rules equals $1 or starts with $1:, RULE_FOUND is set to true
158 #     and $1 is removed from the RULE variable
159 # Otherwise the RULE_FOUND variable is set to false, and RULE left as it was
160 # The function is a bit tricky, since there's no built in $(startswith) function
161 define COMPARE_AND_REMOVE_FROM_RULE_HELPER
162     ifeq ($1,$$(RULE))
163         RULE:=
164         RULE_FOUND := true
165     else
166         STARTCOLON_REMOVED=$$(subst START$1:,,START$$(RULE))
167         ifneq ($$(STARTCOLON_REMOVED),START$$(RULE))
168             RULE_FOUND := true
169             RULE := $$(STARTCOLON_REMOVED)
170         else
171             RULE_FOUND := false
172         endif
173     endif
174 endef
175
176 # This makes it easier to call COMPARE_AND_REMOVE_FROM_RULE, since it makes it behave like
177 # a function that returns the value
178 COMPARE_AND_REMOVE_FROM_RULE = $(eval $(call COMPARE_AND_REMOVE_FROM_RULE_HELPER,$1))$(RULE_FOUND)
179
180
181 # Recursively try to find a match for the start of the rule to be checked
182 # $1 The list to be checked
183 # If a match is found, then RULE_FOUND is set to true
184 # and MATCHED_ITEM to the item that was matched
185 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
186     ifneq ($1,)
187         ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,$$(firstword $1)),true)
188             MATCHED_ITEM := $$(firstword $1)
189         else
190             $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$$(wordlist 2,9999,$1)))
191         endif
192     endif
193 endef
194
195 # A recursive helper function for finding the longest match
196 # $1 The list to be checked
197 # It works by always removing the currently matched item from the list
198 # and call itself recursively, until a match is found
199 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
200     # Stop the recursion when the list is empty
201     ifneq ($1,)
202         RULE_BEFORE := $$(RULE)
203         $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$1))
204         # If a match is found in the current list, otherwise just return what we had before
205         ifeq ($$(RULE_FOUND),true)
206             # Save the best match so far and call itself recursively
207             BEST_MATCH := $$(MATCHED_ITEM)
208             BEST_MATCH_RULE := $$(RULE)
209             RULE_FOUND := false
210             RULE := $$(RULE_BEFORE)
211             $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$$(filter-out $$(MATCHED_ITEM),$1)))
212         endif
213      endif
214 endef
215
216
217 # Recursively try to find the longest match for the start of the rule to be checked
218 # $1 The list to be checked
219 # If a match is found, then RULE_FOUND is set to true
220 # and MATCHED_ITEM to the item that was matched
221 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER
222     BEST_MATCH :=
223     $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$1))
224     ifneq ($$(BEST_MATCH),)
225         RULE_FOUND := true
226         RULE := $$(BEST_MATCH_RULE)
227         MATCHED_ITEM := $$(BEST_MATCH)
228     else
229         RULE_FOUND := false
230         MATCHED_ITEM :=
231     endif
232 endef
233
234 # Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
235 TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
236
237 define ALL_IN_LIST_LOOP
238     OLD_RULE$1 := $$(RULE)
239     $$(eval $$(call $1,$$(ITEM$1)))
240     RULE := $$(OLD_RULE$1)
241 endef
242
243 define PARSE_ALL_IN_LIST
244     $$(foreach ITEM$1,$2,$$(eval $$(call ALL_IN_LIST_LOOP,$1)))
245 endef
246
247 # The entry point for rule parsing
248 # parses a rule in the format <keyboard>:<keymap>:<target>
249 # but this particular function only deals with the first <keyboard> part
250 define PARSE_RULE
251     RULE := $1
252     COMMANDS :=
253     # If the rule starts with all, then continue the parsing from
254     # PARSE_ALL_KEYBOARDS
255     ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
256         $$(eval $$(call PARSE_ALL_KEYBOARDS))
257     else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,test),true)
258         $$(eval $$(call PARSE_TEST))
259     # If the rule starts with the name of a known keyboard, then continue
260     # the parsing from PARSE_KEYBOARD
261     else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYBOARDS)),true)
262         $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
263     # Otherwise use the KEYBOARD variable, which is determined either by
264     # the current directory you run make from, or passed in as an argument
265     else ifneq ($$(KEYBOARD),)
266         $$(eval $$(call PARSE_KEYBOARD,$$(KEYBOARD)))
267     else
268         $$(info make: *** No rule to make target '$1'. Stop.)
269         $$(info |)
270         $$(info |  QMK's make format recently changed to use folder locations and colons:)
271         $$(info |     make project_folder:keymap[:target])
272         $$(info |  Examples:)
273         $$(info |     make planck/rev4:default:dfu)
274         $$(info |     make planck:default)
275         $$(info |)
276     endif
277 endef
278
279 # $1 = Keyboard
280 # Parses a rule in the format <keymap>:<target>
281 # the keyboard is already known when entering this function
282 define PARSE_KEYBOARD
283     # If we want to compile the default subproject, then we need to
284     # include the correct makefile to determine the actual name of it
285     CURRENT_KB := $1
286
287     # KEYBOARD_FOLDERS := $$(subst /, , $(CURRENT_KB))
288
289     DEFAULT_FOLDER := $$(CURRENT_KB)
290
291     # We assume that every rules.mk will contain the full default value
292     $$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/rules.mk)
293     ifneq ($$(DEFAULT_FOLDER),$$(CURRENT_KB))
294         $$(eval include $(ROOT_DIR)/keyboards/$$(DEFAULT_FOLDER)/rules.mk)
295     endif
296     CURRENT_KB := $$(DEFAULT_FOLDER)
297
298     # 5/4/3/2/1
299     KEYBOARD_FOLDER_PATH_1 := $$(CURRENT_KB)
300     KEYBOARD_FOLDER_PATH_2 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_1)))
301     KEYBOARD_FOLDER_PATH_3 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_2)))
302     KEYBOARD_FOLDER_PATH_4 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_3)))
303     KEYBOARD_FOLDER_PATH_5 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_4)))
304     KEYBOARD_FOLDER_1 := $$(notdir $$(KEYBOARD_FOLDER_PATH_1))
305     KEYBOARD_FOLDER_2 := $$(notdir $$(KEYBOARD_FOLDER_PATH_2))
306     KEYBOARD_FOLDER_3 := $$(notdir $$(KEYBOARD_FOLDER_PATH_3))
307     KEYBOARD_FOLDER_4 := $$(notdir $$(KEYBOARD_FOLDER_PATH_4))
308     KEYBOARD_FOLDER_5 := $$(notdir $$(KEYBOARD_FOLDER_PATH_5))
309
310     KEYMAPS :=
311     # get a list of all keymaps
312     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/keymaps/*/.)))
313     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/keymaps/*/.)))
314     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/keymaps/*/.)))
315     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/keymaps/*/.)))
316     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/keymaps/*/.)))
317     # this might be needed, but in a different form
318     #KEYMAPS := $$(sort $$(filter-out $$(KEYBOARD_FOLDER_1) $$(KEYBOARD_FOLDER_2) \
319         $$(KEYBOARD_FOLDER_3) $$(KEYBOARD_FOLDER_4) $$(KEYBOARD_FOLDER_5), $$(KEYMAPS)))
320
321     KEYBOARD_LAYOUTS :=
322     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_5)/rules.mk)","")
323       LAYOUTS :=
324       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_5)/rules.mk)
325       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
326     endif
327     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_4)/rules.mk)","")
328       LAYOUTS :=
329       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_4)/rules.mk)
330       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
331     endif
332     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_3)/rules.mk)","")
333       LAYOUTS :=
334       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_3)/rules.mk)
335       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
336     endif
337     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_2)/rules.mk)","")
338       LAYOUTS :=
339       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_2)/rules.mk)
340       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
341     endif
342     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_1)/rules.mk)","")
343       LAYOUTS :=
344       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_1)/rules.mk)
345       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
346     endif
347
348     LAYOUT_KEYMAPS :=
349     $$(foreach LAYOUT,$$(KEYBOARD_LAYOUTS),$$(eval LAYOUT_KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/layouts/*/$$(LAYOUT)/*/.)))))
350     
351     KEYMAPS := $$(sort $$(KEYMAPS) $$(LAYOUT_KEYMAPS))
352
353     # if the rule after removing the start of it is empty (we haven't specified a kemap or target)
354     # compile all the keymaps
355     ifeq ($$(RULE),)
356         $$(eval $$(call PARSE_ALL_KEYMAPS))
357     # The same if all was specified
358     else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
359         $$(eval $$(call PARSE_ALL_KEYMAPS))
360     # Try to match the specified keyamp with the list of known keymaps
361     else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYMAPS)),true)
362         $$(eval $$(call PARSE_KEYMAP,$$(MATCHED_ITEM)))
363     # Otherwise try to match the keymap from the current folder, or arguments to the make command
364     else ifneq ($$(KEYMAP),)
365         $$(eval $$(call PARSE_KEYMAP,$$(KEYMAP)))
366     # Otherwise, make all keymaps, again this is consistent with how it works without
367     # any arguments
368     else
369         $$(eval $$(call PARSE_ALL_KEYMAPS))
370     endif
371 endef
372
373 # if we are going to compile all keyboards, match the rest of the rule
374 # for each of them
375 define PARSE_ALL_KEYBOARDS
376     $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(KEYBOARDS)))
377 endef
378
379 # $1 Subproject
380 # When entering this, the keyboard and subproject are known, so now we need
381 # to determine which keymaps are going to get compiled
382 # define PARSE_SUBPROJECT
383
384 # endef
385
386 # If we want to parse all subprojects, but the keyboard doesn't have any,
387 # then use defaultsp instead
388 # define PARSE_ALL_SUBPROJECTS
389 #     ifeq ($$(SUBPROJECTS),)
390 #         $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
391 #     else
392 #         $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$$(SUBPROJECTS)))
393 #     endif
394 # endef
395
396 # $1 Keymap
397 # This is the meat of compiling a keyboard, when entering this, everything is known
398 # keyboard, subproject, and keymap
399 # Note that we are not directly calling the command here, but instead building a list,
400 # which will later be processed
401 define PARSE_KEYMAP
402     CURRENT_KM = $1
403     # The rest of the rule is the target
404     # Remove the leading ":" from the target, as it acts as a separator
405     MAKE_TARGET := $$(patsubst :%,%,$$(RULE))
406     # We need to generate an unique indentifer to append to the COMMANDS list
407     CURRENT_KB_UNDER := $$(subst /,_,$$(CURRENT_KB))
408     COMMAND := COMMAND_KEYBOARD_$$(CURRENT_KB_UNDER)_KEYMAP_$$(CURRENT_KM)
409     # If we are compiling a keyboard without a subproject, we want to display just the name
410     # of the keyboard, otherwise keyboard/subproject
411     KB_SP := $$(CURRENT_KB)
412     # Format it in bold
413     KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
414     # Specify the variables that we are passing forward to submake
415     MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM)
416     # And the first part of the make command
417     MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_keyboard.mk $$(MAKE_TARGET)
418     # The message to display
419     MAKE_MSG := $$(MSG_MAKE_KB)
420     # We run the command differently, depending on if we want more output or not
421     # The true version for silent output and the false version otherwise
422     $$(eval $$(call BUILD))
423 endef
424
425 define BUILD
426     MAKE_VARS += VERBOSE=$(VERBOSE) COLOR=$(COLOR)
427     COMMANDS += $$(COMMAND)
428     COMMAND_true_$$(COMMAND) := \
429         printf "$$(MAKE_MSG)" | \
430         $$(MAKE_MSG_FORMAT); \
431         LOG=$$$$($$(MAKE_CMD) $$(MAKE_VARS) SILENT=true 2>&1) ; \
432         if [ $$$$? -gt 0 ]; \
433             then $$(PRINT_ERROR_PLAIN); \
434         elif [ "$$$$LOG" != "" ] ; \
435             then $$(PRINT_WARNING_PLAIN); \
436         else \
437             $$(PRINT_OK); \
438         fi;
439     COMMAND_false_$$(COMMAND) := \
440         printf "$$(MAKE_MSG)\n\n"; \
441         $$(MAKE_CMD) $$(MAKE_VARS) SILENT=false; \
442         if [ $$$$? -gt 0 ]; \
443             then error_occurred=1; \
444         fi;
445 endef
446
447 # Just parse all the keymaps for a specific keyboard
448 define PARSE_ALL_KEYMAPS
449     $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYMAP,$$(KEYMAPS)))
450 endef
451
452 define BUILD_TEST
453     TEST_NAME := $1
454     MAKE_TARGET := $2
455     COMMAND := $1
456     MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_test.mk $$(MAKE_TARGET)
457     MAKE_VARS := TEST=$$(TEST_NAME) FULL_TESTS="$$(FULL_TESTS)"
458     MAKE_MSG := $$(MSG_MAKE_TEST)
459     $$(eval $$(call BUILD))
460     ifneq ($$(MAKE_TARGET),clean)
461         TEST_EXECUTABLE := $$(TEST_DIR)/$$(TEST_NAME).elf
462         TESTS += $$(TEST_NAME)
463         TEST_MSG := $$(MSG_TEST)
464         $$(TEST_NAME)_COMMAND := \
465             printf "$$(TEST_MSG)\n"; \
466             $$(TEST_EXECUTABLE); \
467             if [ $$$$? -gt 0 ]; \
468                 then error_occurred=1; \
469             fi; \
470             printf "\n";
471     endif
472 endef
473
474 define PARSE_TEST
475     TESTS :=
476     TEST_NAME := $$(firstword $$(subst :, ,$$(RULE)))
477     TEST_TARGET := $$(subst $$(TEST_NAME),,$$(subst $$(TEST_NAME):,,$$(RULE)))
478     ifeq ($$(TEST_NAME),all)
479         MATCHED_TESTS := $$(TEST_LIST)
480     else
481         MATCHED_TESTS := $$(foreach TEST,$$(TEST_LIST),$$(if $$(findstring $$(TEST_NAME),$$(TEST)),$$(TEST),))
482     endif
483     $$(foreach TEST,$$(MATCHED_TESTS),$$(eval $$(call BUILD_TEST,$$(TEST),$$(TEST_TARGET))))
484 endef
485
486
487 # Set the silent mode depending on if we are trying to compile multiple keyboards or not
488 # By default it's on in that case, but it can be overridden by specifying silent=false
489 # from the command line
490 define SET_SILENT_MODE
491     ifdef SUB_IS_SILENT
492         SILENT_MODE := $(SUB_IS_SILENT)
493     else ifeq ($$(words $$(COMMANDS)),1)
494         SILENT_MODE := false
495     else
496         SILENT_MODE := true
497     endif
498 endef
499
500 include $(ROOT_DIR)/message.mk
501
502 ifeq ($(strip $(BREAK_ON_ERRORS)), yes)
503 HANDLE_ERROR = exit 1
504 else
505 HANDLE_ERROR = echo $$error_occurred > $(ERROR_FILE)
506 endif
507
508 # The empty line is important here, as it will force a new shell to be created for each command
509 # Otherwise the command line will become too long with a lot of keyboards and keymaps
510 define RUN_COMMAND
511 +error_occurred=0;\
512 $(COMMAND_$(SILENT_MODE)_$(COMMAND))\
513 if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
514
515
516 endef
517 define RUN_TEST
518 +error_occurred=0;\
519 $($(TEST)_COMMAND)\
520 if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
521
522
523 endef
524
525 # Let's match everything, we handle all the rule parsing ourselves
526 .PHONY: %
527 %:
528         # Check if we have the CMP tool installed
529         cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
530         # Check if the submodules are dirty, and display a warning if they are
531 ifndef SKIP_GIT
532         if [ ! -e lib/chibios ]; then git submodule sync lib/chibios && git submodule update --init lib/chibios; fi
533         if [ ! -e lib/chibios-contrib ]; then git submodule sync lib/chibios-contrib && git submodule update --init lib/chibios-contrib; fi
534         if [ ! -e lib/ugfx ]; then git submodule sync lib/ugfx && git submodule update --init lib/ugfx; fi
535         git submodule status --recursive 2>/dev/null | \
536         while IFS= read -r x; do \
537                 case "$$x" in \
538                         \ *) ;; \
539                         *) printf "$(MSG_SUBMODULE_DIRTY)";break;; \
540                 esac \
541         done
542 endif
543         rm -f $(ERROR_FILE) > /dev/null 2>&1
544         $(eval $(call PARSE_RULE,$@))
545         $(eval $(call SET_SILENT_MODE))
546         # Run all the commands in the same shell, notice the + at the first line
547         # it has to be there to allow parallel execution of the submake
548         # This always tries to compile everything, even if error occurs in the middle
549         # But we return the error code at the end, to trigger travis failures
550         $(foreach COMMAND,$(COMMANDS),$(RUN_COMMAND))
551         if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
552         $(foreach TEST,$(TESTS),$(RUN_TEST))
553         if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
554
555 # These no longer work because of the colon system
556
557 # All should compile everything
558 # .PHONY: all
559 # all: all-keyboards test-all
560
561 # Define some shortcuts, mostly for compatibility with the old syntax
562 # .PHONY: all-keyboards
563 # all-keyboards: all\:all\:all
564
565 # .PHONY: all-keyboards-defaults
566 # all-keyboards-defaults: all\:default
567
568 # .PHONY: test
569 # test: test-all
570
571 # .PHONY: test-clean
572 # test-clean: test-all-clean
573
574 lib/%:
575         git submodule sync $?
576         git submodule update --init $?
577
578 git-submodule:
579         git submodule sync --recursive
580         git submodule update --init --recursive
581
582 ifdef SKIP_VERSION
583 SKIP_GIT := yes
584 endif
585
586 # Generate the version.h file
587 ifndef SKIP_GIT
588     GIT_VERSION := $(shell git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
589 else
590     GIT_VERSION := NA
591 endif
592 ifndef SKIP_VERSION
593 BUILD_DATE := $(shell date +"%Y-%m-%d-%H:%M:%S")
594 $(shell echo '#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR)/quantum/version.h)
595 $(shell echo '#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR)/quantum/version.h)
596 else
597 BUILD_DATE := NA
598 endif
599
600 include $(ROOT_DIR)/testlist.mk