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