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
24 STARTING_MAKEFILE
:= $(firstword $(MAKEFILE_LIST
))
25 ROOT_MAKEFILE
:= $(lastword
$(MAKEFILE_LIST
))
26 ROOT_DIR
:= $(dir $(ROOT_MAKEFILE
))
30 ABS_STARTING_MAKEFILE
:= $(abspath
$(STARTING_MAKEFILE
))
31 ABS_ROOT_MAKEFILE
:= $(abspath
$(ROOT_MAKEFILE
))
32 ABS_STARTING_DIR
:= $(dir $(ABS_STARTING_MAKEFILE
))
33 ABS_ROOT_DIR
:= $(dir $(ABS_ROOT_MAKEFILE
))
34 STARTING_DIR
:= $(subst $(ABS_ROOT_DIR
),,$(ABS_STARTING_DIR
))
35 BUILD_DIR
:= $(ROOT_DIR
)/.build
36 TEST_DIR
:= $(BUILD_DIR
)/test
37 ERROR_FILE
:= $(BUILD_DIR
)/error_occurred
41 # Helper function to process the newt element of a space separated path
42 # It works a bit like the traditional functional head tail
43 # so the CURRENT_PATH_ELEMENT will become the new head
44 # and the PATH_ELEMENTS are the rest that are still unprocessed
45 define NEXT_PATH_ELEMENT
46 $$(eval CURRENT_PATH_ELEMENT
:= $$(firstword $$(PATH_ELEMENTS
)))
47 $$(eval PATH_ELEMENTS
:= $$(wordlist
2,9999,$$(PATH_ELEMENTS
)))
50 # We change the / to spaces so that we more easily can work with the elements
52 PATH_ELEMENTS
:= $(subst /, ,$(STARTING_DIR
))
53 # Initialize the path elements list for further processing
54 $(eval
$(call NEXT_PATH_ELEMENT
))
56 # This function sets the KEYBOARD; KEYMAP and SUBPROJECT to the correct
57 # variables depending on which directory you stand in.
58 # It's really a very simple if else chain, if you squint enough,
59 # but the makefile syntax makes it very verbose.
60 # If we are in a subfolder of keyboards
61 ifeq ($(CURRENT_PATH_ELEMENT
),keyboards
)
62 $(eval
$(call NEXT_PATH_ELEMENT
))
63 KEYBOARD
:= $(CURRENT_PATH_ELEMENT
)
64 $(eval
$(call NEXT_PATH_ELEMENT
))
65 # If we are in a subfolder of keymaps, or in other words in a keymap
67 ifeq ($(CURRENT_PATH_ELEMENT
),keymaps
)
68 $(eval
$(call NEXT_PATH_ELEMENT
))
69 KEYMAP
:= $(CURRENT_PATH_ELEMENT
)
70 # else if we are not in the keyboard folder itself
71 else ifneq ($(CURRENT_PATH_ELEMENT
),)
72 # the we can assume it's a subproject, as no other folders
73 # should have make files in them
74 SUBPROJECT
:= $(CURRENT_PATH_ELEMENT
)
75 $(eval
$(call NEXT_PATH_ELEMENT
))
76 # if we are inside a keymap folder of a subproject
77 ifeq ($(CURRENT_PATH_ELEMENT
),keymaps
)
78 $(eval
$(call NEXT_PATH_ELEMENT
))
79 KEYMAP
:= $(CURRENT_PATH_ELEMENT
)
84 # Only consider folders with makefiles, to prevent errors in case there are extra folders
85 KEYBOARDS
:= $(notdir $(patsubst %/Makefile
,%,$(wildcard $(ROOT_DIR
)/keyboards
/*/Makefile
)))
87 #Compatibility with the old make variables, anything you specify directly on the command line
88 # always overrides the detected folders
90 KEYBOARD
:= $(keyboard
)
96 SUBPROJECT
:= $(subproject
)
102 # Uncomment these for debugging
103 #$(info Keyboard: $(KEYBOARD))
104 #$(info Keymap: $(KEYMAP))
105 #$(info Subproject: $(SUBPROJECT))
106 #$(info Keyboards: $(KEYBOARDS))
109 # Set the default goal depending on where we are running make from
110 # this handles the case where you run make without any arguments
113 ifeq ($(SUBPROJECT
),)
114 # Inside a keymap folder, just build the keymap, with the
116 .DEFAULT_GOAL
:= $(KEYBOARD
)-$(KEYMAP
)
118 # Inside a subproject keyamp folder, build the keymap
119 # for that subproject
120 .DEFAULT_GOAL
:= $(KEYBOARD
)-$(SUBPROJECT
)-$(KEYMAP
)
122 else ifneq ($(SUBPROJECT
),)
123 # Inside a subproject folder, build all keymaps for that subproject
124 .DEFAULT_GOAL
:= $(KEYBOARD
)-$(SUBPROJECT
)-allkm
125 else ifneq ($(KEYBOARD
),)
126 # Inside a keyboard folder, build all keymaps for all subprojects
127 # Note that this is different from the old behaviour, which would
128 # build only the default keymap of the default keyboard
129 .DEFAULT_GOAL
:= $(KEYBOARD
)-allsp-allkm
133 # Compare the start of the RULE variable with the first argument($1)
134 # If the rules equals $1 or starts with $1-, RULE_FOUND is set to true
135 # and $1 is removed from the RULE variable
136 # Otherwise the RULE_FOUND variable is set to false, and RULE left as it was
137 # The function is a bit tricky, since there's no built in $(startswith) function
138 define COMPARE_AND_REMOVE_FROM_RULE_HELPER
143 STARTDASH_REMOVED
=$$(subst START
$1-,,START
$$(RULE
))
144 ifneq ($$(STARTDASH_REMOVED
),START
$$(RULE
))
146 RULE
:= $$(STARTDASH_REMOVED
)
153 # This makes it easier to call COMPARE_AND_REMOVE_FROM_RULE, since it makes it behave like
154 # a function that returns the value
155 COMPARE_AND_REMOVE_FROM_RULE
= $(eval
$(call COMPARE_AND_REMOVE_FROM_RULE_HELPER
,$1))$(RULE_FOUND
)
158 # Recursively try to find a match for the start of the rule to be checked
159 # $1 The list to be checked
160 # If a match is found, then RULE_FOUND is set to true
161 # and MATCHED_ITEM to the item that was matched
162 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
164 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,$$(firstword $1)),true
)
165 MATCHED_ITEM
:= $$(firstword $1)
167 $$(eval
$$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
,$$(wordlist
2,9999,$1)))
172 # A recursive helper function for finding the longest match
173 # $1 The list to be checked
174 # It works by always removing the currently matched item from the list
175 # and call itself recursively, until a match is found
176 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
177 # Stop the recursion when the list is empty
179 RULE_BEFORE
:= $$(RULE
)
180 $$(eval
$$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
,$1))
181 # If a match is found in the current list, otherwise just return what we had before
182 ifeq ($$(RULE_FOUND
),true
)
183 # Save the best match so far and call itself recursively
184 BEST_MATCH
:= $$(MATCHED_ITEM
)
185 BEST_MATCH_RULE
:= $$(RULE
)
187 RULE
:= $$(RULE_BEFORE
)
188 $$(eval
$$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
,$$(filter-out $$(MATCHED_ITEM
),$1)))
194 # Recursively try to find the longest match for the start of the rule to be checked
195 # $1 The list to be checked
196 # If a match is found, then RULE_FOUND is set to true
197 # and MATCHED_ITEM to the item that was matched
198 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER
200 $$(eval
$$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
,$1))
201 ifneq ($$(BEST_MATCH
),)
203 RULE
:= $$(BEST_MATCH_RULE
)
204 MATCHED_ITEM
:= $$(BEST_MATCH
)
211 # Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
212 TRY_TO_MATCH_RULE_FROM_LIST
= $(eval
$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER
,$1))$(RULE_FOUND
)
214 define ALL_IN_LIST_LOOP
215 OLD_RULE
$1 := $$(RULE
)
216 $$(eval
$$(call
$1,$$(ITEM
$1)))
217 RULE
:= $$(OLD_RULE
$1)
220 define PARSE_ALL_IN_LIST
221 $$(foreach ITEM
$1,$2,$$(eval
$$(call ALL_IN_LIST_LOOP
,$1)))
224 # The entry point for rule parsing
225 # parses a rule in the format <keyboard>-<subproject>-<keymap>-<target>
226 # but this particular function only deals with the first <keyboard> part
230 # If the rule starts with allkb, then continue the parsing from
231 # PARSE_ALL_KEYBOARDS
232 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,allkb
),true
)
233 $$(eval
$$(call PARSE_ALL_KEYBOARDS
))
234 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,test),true
)
235 $$(eval
$$(call PARSE_TEST
))
236 # If the rule starts with the name of a known keyboard, then continue
237 # the parsing from PARSE_KEYBOARD
238 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST
,$$(KEYBOARDS
)),true
)
239 $$(eval
$$(call PARSE_KEYBOARD
,$$(MATCHED_ITEM
)))
240 # Otherwise use the KEYBOARD variable, which is determined either by
241 # the current directory you run make from, or passed in as an argument
242 else ifneq ($$(KEYBOARD
),)
243 $$(eval
$$(call PARSE_KEYBOARD
,$$(KEYBOARD
)))
245 $$(info make
: *** No rule to make target
'$1'. Stop.
)
246 # Notice the tab instead of spaces below!
252 # Parses a rule in the format <subproject>-<keymap>-<target>
253 # the keyboard is already known when entering this function
254 define PARSE_KEYBOARD
256 # A subproject is any keyboard subfolder with a makefile
257 SUBPROJECTS
:= $$(notdir $$(patsubst %/Makefile
,%,$$(wildcard $(ROOT_DIR
)/keyboards
/$$(CURRENT_KB
)/*/Makefile
)))
258 # if the rule starts with allsp, then continue with looping over all subprojects
259 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,allsp
),true
)
260 $$(eval
$$(call PARSE_ALL_SUBPROJECTS
))
261 # A special case for matching the defaultsp (default subproject)
262 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,defaultsp
),true
)
263 $$(eval
$$(call PARSE_SUBPROJECT
,defaultsp
))
264 # If the rule starts with the name of a known subproject
265 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST
,$$(SUBPROJECTS
)),true
)
266 $$(eval
$$(call PARSE_SUBPROJECT
,$$(MATCHED_ITEM
)))
267 # Try to use the SUBPROJECT variable, which is either determined by the
268 # directory which invoked make, or passed as an argument to make
269 else ifneq ($$(SUBPROJECT
),)
270 $$(eval
$$(call PARSE_SUBPROJECT
,$$(SUBPROJECT
)))
271 # If there's no matching subproject, we assume it's the default
272 # This will allow you to leave the subproject part of the target out
274 $$(eval
$$(call PARSE_SUBPROJECT
,))
278 # if we are going to compile all keyboards, match the rest of the rule
280 define PARSE_ALL_KEYBOARDS
281 $$(eval
$$(call PARSE_ALL_IN_LIST
,PARSE_KEYBOARD
,$(KEYBOARDS
)))
285 # When entering this, the keyboard and subproject are known, so now we need
286 # to determine which keymaps are going to get compiled
287 define PARSE_SUBPROJECT
288 # If we want to compile the default subproject, then we need to
289 # include the correct makefile to determine the actual name of it
291 ifeq ($$(CURRENT_SP
),)
292 CURRENT_SP
:= defaultsp
294 ifeq ($$(CURRENT_SP
),defaultsp
)
296 $$(eval
include $(ROOT_DIR
)/keyboards
/$$(CURRENT_KB
)/Makefile
)
297 CURRENT_SP
:= $$(SUBPROJECT_DEFAULT
)
299 # If current subproject is empty (the default was not defined), and we have a list of subproject
300 # then make all of them
301 ifeq ($$(CURRENT_SP
),)
302 ifneq ($$(SUBPROJECTS
),)
306 # The special allsp is handled later
307 ifneq ($$(CURRENT_SP
),allsp
)
308 # get a list of all keymaps
309 KEYMAPS
:= $$(notdir $$(patsubst %/.
,%,$$(wildcard $(ROOT_DIR
)/keyboards
/$$(CURRENT_KB
)/keymaps
/*/.
)))
310 ifneq ($$(CURRENT_SP
),)
311 # if the subproject is defined, then also look for keymaps inside the subproject folder
312 SP_KEYMAPS
:= $$(notdir $$(patsubst %/.
,%,$$(wildcard $(ROOT_DIR
)/keyboards
/$$(CURRENT_KB
)/$$(CURRENT_SP
)/keymaps
/*/.
)))
313 KEYMAPS
:= $$(sort $$(KEYMAPS
) $$(SP_KEYMAPS
))
315 # if the rule after removing the start of it is empty (we haven't specified a kemap or target)
316 # compile all the keymaps
318 $$(eval
$$(call PARSE_ALL_KEYMAPS
))
319 # The same if allkm was specified
320 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE
,allkm
),true
)
321 $$(eval
$$(call PARSE_ALL_KEYMAPS
))
322 # Try to match the specified keyamp with the list of known keymaps
323 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST
,$$(KEYMAPS
)),true
)
324 $$(eval
$$(call PARSE_KEYMAP
,$$(MATCHED_ITEM
)))
325 # Otherwise try to match the keymap from the current folder, or arguments to the make command
326 else ifneq ($$(KEYMAP
),)
327 $$(eval
$$(call PARSE_KEYMAP
,$$(KEYMAP
)))
328 # No matching keymap found, so we assume that the rest of the rule is the target
329 # If we haven't been able to parse out a subproject, then make all of them
330 # This is consistent with running make without any arguments from the keyboard
333 $$(eval
$$(call PARSE_ALL_SUBPROJECTS
))
334 # Otherwise, make all keymaps, again this is consistent with how it works without
337 $$(eval
$$(call PARSE_ALL_KEYMAPS
))
340 # As earlier mentioned when allsb is specified, we call our self recursively
341 # for all of the subprojects
342 $$(eval
$$(call PARSE_ALL_IN_LIST
,PARSE_SUBPROJECT
,$(SUBPROJECTS
)))
346 # If we want to parse all subprojects, but the keyboard doesn't have any,
347 # then use defaultsp instead
348 define PARSE_ALL_SUBPROJECTS
349 ifeq ($$(SUBPROJECTS
),)
350 $$(eval
$$(call PARSE_SUBPROJECT
,defaultsp
))
352 $$(eval
$$(call PARSE_ALL_IN_LIST
,PARSE_SUBPROJECT
,$$(SUBPROJECTS
)))
357 # This is the meat of compiling a keyboard, when entering this, everything is known
358 # keyboard, subproject, and keymap
359 # Note that we are not directly calling the command here, but instead building a list,
360 # which will later be processed
363 # The rest of the rule is the target
364 # Remove the leading "-" from the target, as it acts as a separator
365 MAKE_TARGET
:= $$(patsubst -%,%,$$(RULE
))
366 # We need to generate an unique indentifer to append to the COMMANDS list
367 COMMAND
:= COMMAND_KEYBOARD_
$$(CURRENT_KB
)_SUBPROJECT_
$(CURRENT_SP
)_KEYMAP_
$$(CURRENT_KM
)
368 # If we are compiling a keyboard without a subproject, we want to display just the name
369 # of the keyboard, otherwise keyboard/subproject
370 ifeq ($$(CURRENT_SP
),)
371 KB_SP
:= $(CURRENT_KB
)
373 KB_SP
:= $(CURRENT_KB
)/$$(CURRENT_SP
)
376 KB_SP
:= $(BOLD
)$$(KB_SP
)$(NO_COLOR
)
377 # Specify the variables that we are passing forward to submake
378 MAKE_VARS
:= KEYBOARD
=$$(CURRENT_KB
) SUBPROJECT
=$$(CURRENT_SP
) KEYMAP
=$$(CURRENT_KM
)
379 # And the first part of the make command
380 MAKE_CMD
:= $$(MAKE
) -r
-R
-C
$(ROOT_DIR
) -f build_keyboard.mk
$$(MAKE_TARGET
)
381 # The message to display
382 MAKE_MSG
:= $$(MSG_MAKE_KB
)
383 # We run the command differently, depending on if we want more output or not
384 # The true version for silent output and the false version otherwise
385 $$(eval
$$(call BUILD
))
389 MAKE_VARS
+= VERBOSE
=$(VERBOSE
) COLOR
=$(COLOR
)
390 COMMANDS
+= $$(COMMAND
)
391 COMMAND_true_
$$(COMMAND
) := \
392 printf
"$$(MAKE_MSG)" | \
393 $$(MAKE_MSG_FORMAT
); \
394 LOG
=$$$$($$(MAKE_CMD
) $$(MAKE_VARS
) SILENT
=true
2>&1) ; \
395 if
[ $$$$?
-gt
0 ]; \
396 then
$$(PRINT_ERROR_PLAIN
); \
397 elif
[ "$$$$LOG" != "" ] ; \
398 then
$$(PRINT_WARNING_PLAIN
); \
402 COMMAND_false_
$$(COMMAND
) := \
403 printf
"$$(MAKE_MSG)\n\n"; \
404 $$(MAKE_CMD
) $$(MAKE_VARS
) SILENT
=false
; \
405 if
[ $$$$?
-gt
0 ]; \
406 then error_occurred
=1; \
410 # Just parse all the keymaps for a specific keyboard
411 define PARSE_ALL_KEYMAPS
412 $$(eval
$$(call PARSE_ALL_IN_LIST
,PARSE_KEYMAP
,$$(KEYMAPS
)))
419 MAKE_CMD
:= $$(MAKE
) -r
-R
-C
$(ROOT_DIR
) -f build_test.mk
$$(MAKE_TARGET
)
420 MAKE_VARS
:= TEST
=$$(TEST_NAME
)
421 MAKE_MSG
:= $$(MSG_MAKE_TEST
)
422 $$(eval
$$(call BUILD
))
423 ifneq ($$(MAKE_TARGET
),clean)
424 TEST_EXECUTABLE
:= $$(TEST_DIR
)/$$(TEST_NAME
).elf
425 TESTS
+= $$(TEST_NAME
)
426 TEST_MSG
:= $$(MSG_TEST
)
427 $$(TEST_NAME
)_COMMAND
:= \
428 printf
"$$(TEST_MSG)\n"; \
429 $$(TEST_EXECUTABLE
); \
430 if
[ $$$$?
-gt
0 ]; \
431 then error_occurred
=1; \
439 TEST_NAME
:= $$(firstword $$(subst -, ,$$(RULE
)))
440 TEST_TARGET
:= $$(subst $$(TEST_NAME
),,$$(subst $$(TEST_NAME
)-,,$$(RULE
)))
441 ifeq ($$(TEST_NAME
),all)
442 MATCHED_TESTS
:= $$(TEST_LIST
)
444 MATCHED_TESTS
:= $$(foreach TEST
,$$(TEST_LIST
),$$(if
$$(findstring $$(TEST_NAME
),$$(TEST
)),$$(TEST
),))
446 $$(foreach TEST
,$$(MATCHED_TESTS
),$$(eval
$$(call BUILD_TEST
,$$(TEST
),$$(TEST_TARGET
))))
450 # Set the silent mode depending on if we are trying to compile multiple keyboards or not
451 # By default it's on in that case, but it can be overridden by specifying silent=false
452 # from the command line
453 define SET_SILENT_MODE
455 SILENT_MODE
:= $(SUB_IS_SILENT
)
456 else ifeq ($$(words $$(COMMANDS
)),1)
463 include $(ROOT_DIR
)/message.mk
465 # The empty line is important here, as it will force a new shell to be created for each command
466 # Otherwise the command line will become too long with a lot of keyboards and keymaps
469 $(COMMAND_
$(SILENT_MODE
)_
$(COMMAND
))\
470 if
[ $$error_occurred -gt
0 ]; then echo
$$error_occurred > $(ERROR_FILE
); fi
;
477 if
[ $$error_occurred -gt
0 ]; then echo
$$error_occurred > $(ERROR_FILE
); fi
;
481 # Allow specifying just the subproject, in the keyboard directory, which will compile all keymaps
482 SUBPROJECTS
:= $(notdir $(patsubst %/Makefile
,%,$(wildcard .
/*/Makefile
)))
483 .PHONY
: $(SUBPROJECTS
)
484 $(SUBPROJECTS
): %: %-allkm
486 # Let's match everything, we handle all the rule parsing ourselves
489 # Check if we have the CMP tool installed
490 cmp
$(ROOT_DIR
)/Makefile
$(ROOT_DIR
)/Makefile
>/dev
/null
2>&1; if
[ $$?
-gt
0 ]; then printf
"$(MSG_NO_CMP)"; exit
1; fi
;
491 # Check if the submodules are dirty, and display a warning if they are
493 git submodule status
--recursive
2>/dev
/null | \
494 while IFS
= read
-r x
; do \
497 *) printf
"$(MSG_SUBMODULE_DIRTY)";break
;; \
501 rm -f
$(ERROR_FILE
) > /dev
/null
2>&1
502 $(eval
$(call PARSE_RULE
,$@
))
503 $(eval
$(call SET_SILENT_MODE
))
504 # Run all the commands in the same shell, notice the + at the first line
505 # it has to be there to allow parallel execution of the submake
506 # This always tries to compile everything, even if error occurs in the middle
507 # But we return the error code at the end, to trigger travis failures
508 $(foreach COMMAND
,$(COMMANDS
),$(RUN_COMMAND
))
509 if
[ -f
$(ERROR_FILE
) ]; then printf
"$(MSG_ERRORS)" & exit
1; fi
;
510 $(foreach TEST
,$(TESTS
),$(RUN_TEST
))
511 if
[ -f
$(ERROR_FILE
) ]; then printf
"$(MSG_ERRORS)" & exit
1; fi
;
513 # All should compile everything
515 all: all-keyboards test-all
517 # Define some shortcuts, mostly for compatibility with the old syntax
518 .PHONY
: all-keyboards
519 all-keyboards
: allkb-allsp-allkm
521 .PHONY
: all-keyboards-defaults
522 all-keyboards-defaults
: allkb-allsp-default
528 test-clean
: test-all-clean
530 # Generate the version.h file
532 GIT_VERSION
:= $(shell git describe
--abbrev
=6 --dirty
--always
--tags 2>/dev
/null || date
+"%Y-%m-%d-%H:%M:%S")
536 BUILD_DATE
:= $(shell date
+"%Y-%m-%d-%H:%M:%S")
537 $(shell echo
'#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR
)/quantum
/version.h
)
538 $(shell echo
'#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR
)/quantum
/version.h
)
540 include $(ROOT_DIR
)/testlist.mk