alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '56c12996ad'
${ noResults }
Kaleidoscope/Makefile

163 lines
5.5 KiB
Raw Normal View History Unescape

Turn off GNU Make's historical "implicit" rules. They add a ton of overhead and we don't use 'em
3 years ago
# Reset a bunch of historical GNU make implicit rules that we never
# use, but which have a disastrous impact on performance
#
# --no-builtin-rules in MAKEFLAGS apparently came in with GNU Make 4,
# which is newer than what Apple ships
MAKEFLAGS += --no-builtin-rules
# These lines reset the implicit rules we really care about
%:: %,v
%:: RCS/%,v
%:: RCS/%
%:: s.%
%:: SCCS/s.%
.SUFFIXES:
If you're using gmake 4.0 or newer, display simulator test output nicer
3 years ago
# GNU Make earlier than 4.0 don't have the output-sync option, but we need it
# to make parallel simulator test output readable. (otherwise it gets interleaved)
ifeq ($(shell test $(firstword $(subst ., ,$(MAKE_VERSION))) -ge 4; echo $$?),0)
Don't interleave output from test suite when running under gmake4 or newer. On gmake 3, warn the user
3 years ago
MAKEFLAGS+=--output-sync=target
else
_using_old_make=1
If you're using gmake 4.0 or newer, display simulator test output nicer
3 years ago
endif
Turn off GNU Make's historical "implicit" rules. They add a ton of overhead and we don't use 'em
3 years ago
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
include $(dir $(abspath $(lastword $(MAKEFILE_LIST))))/etc/makefiles/arduino-cli.mk
move build-gtest-gmock into the Makefile
4 years ago
Don't pass TEST_PATH to docker unless it's set
4 years ago
# Set up an argument for passing to the simulator tests in docker
# but if the var isn't set, don't even pass the definition
# since this messes with downstream makefiles
ifneq ($(TEST_PATH),)
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
TEST_PATH_ARG="TEST_PATH='$(TEST_PATH)'"
Don't pass TEST_PATH to docker unless it's set
4 years ago
endif
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
DEFAULT_GOAL: smoke-sketches
Don't pass TEST_PATH to docker unless it's set
4 years ago
'make clean' fixes
4 years ago
Kaleidoscope build system support for gd32 keyboards
3 years ago
setup: $(ARDUINO_CLI_PATH) $(ARDUINO_DIRECTORIES_DATA)/arduino-cli.yaml install-arduino-core-avr install-arduino-core-kaleidoscope $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/avr/boards.txt $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/virtual/boards.txt
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
@:
move run-tests out to the Makefile
4 years ago
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
checkout-platform: $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/avr/boards.txt
@:
Move a bunch of makefile targets from the generic sketch makefile
4 years ago
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
prepare-virtual: $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/virtual/boards.txt
@:
$(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/virtual/boards.txt:
$(MAKE) -C $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio prepare-virtual
$(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/avr/boards.txt:
Kaleidoscope build system support for gd32 keyboards
3 years ago
git clone -c core.symlinks=true \
Because of how we call arduino-cli, we no longer need to play games with not checking out the copy of Kaleidoscope inside our arduino cores
3 years ago
--recurse-submodules \
When running make setup, only clone our submodules shallowly. It's easy for a developer to fix when they want/need to and for 99.9% of use cases is "the right thing" It should also make initial setup much faster
3 years ago
--shallow-submodules \
When checking out our arduino core deps for Kaleidoscope dev and use, we don't need the extra copy of Kaleidoscope or the bootloader source code which is included in Arduino cores by convention
3 years ago
--recurse-submodules=':(exclude)avr/bootloaders' \
--recurse-submodules=':(exclude)avr/libraries/Kaleidoscope' \
Hotfix for https://github.blog/2021-09-01-improving-git-protocol-security-github/
3 years ago
https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio \
Kaleidoscope build system support for gd32 keyboards
3 years ago
$(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio
git clone -c core.symlinks=true \
Because of how we call arduino-cli, we no longer need to play games with not checking out the copy of Kaleidoscope inside our arduino cores
3 years ago
--recurse-submodules \
When running make setup, only clone our submodules shallowly. It's easy for a developer to fix when they want/need to and for 99.9% of use cases is "the right thing" It should also make initial setup much faster
3 years ago
--shallow-submodules \
When checking out our arduino core deps for Kaleidoscope dev and use, we don't need the extra copy of Kaleidoscope or the bootloader source code which is included in Arduino cores by convention
3 years ago
--recurse-submodules=':(exclude)libraries/Kaleidoscope' \
Hotfix for https://github.blog/2021-09-01-improving-git-protocol-security-github/
3 years ago
https://github.com/keyboardio/ArduinoCore-GD32-Keyboardio $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/gd32
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
Add a new 'update' makefile target to make it easier to keep our arduino cores up to date when developing Kaleidoscope
3 years ago
update:
cd $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio; git pull; \
git submodule update --init --recursive
cd $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/gd32; git pull; \
git submodule update --init --recursive
Rejigger the makefile and dockerfile to do arduino setup when building the docker file, rather than at simulator-test runtime. Should be a bit faster and re-enable sim tests while offline
4 years ago
simulator-tests:
Don't interleave output from test suite when running under gmake4 or newer. On gmake 3, warn the user
3 years ago
ifneq ($(_using_old_make),)
$(info You're using an older version of GNU Make that doesn't offer the --output-sync option. If you're running the test suite in parallel, output may be garbled. You might consider using GNU Make 4.0 or later instead)
endif
Move a bunch of makefile targets from the generic sketch makefile
4 years ago
$(MAKE) -C tests all
docker-simulator-tests:
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
ARDUINO_DIRECTORIES_USER="$(ARDUINO_DIRECTORIES_USER)" ./bin/run-docker "make simulator-tests $(TEST_PATH_ARG)"
docker-clean:
Simplify our docker execution (#1124) * Switch docker to no longer build a bundle separate from the kaleidoscope dir. Stop copying over a bunch of tarballs we don't need. * fix shellcheck * Stop copying the core-bundled copies of Kaleidoscope over to docker * Symlink our Kaleidoscope into the versions packaged into the arduino cores when running in docker. We need to do this to satisfy the sketch_header.h/sketch_footer.h system we use to be able to amend arduino sketches on avr and virtual. (This feature is not used by the core and may be removed in the future) * Reimplement docker-clean to do much less work and get the same result * Add a stub at docs for the docker test runner
3 years ago
_NO_SYNC_KALEIDOSCOPE=1 ARDUINO_DIRECTORIES_USER="$(ARDUINO_DIRECTORIES_USER)" ./bin/run-docker "rm -rf -- testing/googletest/build/* _build/* /kaleidoscope-persist/temp/*"
Move a bunch of makefile targets from the generic sketch makefile
4 years ago
Add a utility makefile target to get shell in docker
4 years ago
docker-bash:
docker-bash now mounts Kaleidoscope live and interactive (#1125) * docker-bash now mounts Kaleidoscope live and interactive * Switch to a less rigorous but still apropriate mounting method for volumes in docker when running 'make docker-bash'
3 years ago
_NO_SYNC_KALEIDOSCOPE=1 DOCKER_LIVE_KALEIDOSCOPE_DIR=1 ARDUINO_DIRECTORIES_USER="$(ARDUINO_DIRECTORIES_USER)" ./bin/run-docker "bash"
Add a utility makefile target to get shell in docker
4 years ago
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
run-tests: $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/virtual/boards.txt build-gtest-gmock
move run-tests out to the Makefile
4 years ago
$(MAKE) -c tests
@: # blah
move build-gtest-gmock into the Makefile
4 years ago
build-gtest-gmock:
Hotfix for the macos compiler fixes for the virtual platform
3 years ago
(cd testing/googletest && cmake -H. -Bbuild -DCMAKE_C_COMPILER=$(call _arduino_prop,compiler.path)$(call _arduino_prop,compiler.c.cmd) -DCMAKE_CXX_COMPILER=$(call _arduino_prop,compiler.path)$(call _arduino_prop,compiler.cpp.cmd) .)
move build-gtest-gmock into the Makefile
4 years ago
$(MAKE) -C testing/googletest
Move a bunch of makefile targets from the generic sketch makefile
4 years ago
adjust-git-timestamps:
bin/set-timestamps-from-git
find-filename-conflicts:
There's no reason to do the directory check before trying to run our filename checking script
3 years ago
bin/find-filename-conflicts
Move a bunch of makefile targets from the generic sketch makefile
4 years ago
Switch from astyle to clang-format for automated code formatting I added a `.clang-format` file to try to get as close as possible to our current code formatting. I also updated the makefile targets and the github workflows. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
3 years ago
.PHONY: format check-formatting cpplint cpplint-noisy shellcheck smoke-examples find-filename-conflicts prepare-virtual checkout-platform adjust-git-timestamps docker-bash docker-simulator-tests run-tests simulator-tests setup
Lift a bunch more project-specific stuff out of the generic makefile for sketches
4 years ago
Switch from astyle to clang-format for automated code formatting I added a `.clang-format` file to try to get as close as possible to our current code formatting. I also updated the makefile targets and the github workflows. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
3 years ago
format:
Replace clang-format wrapper script with something more configurable This python script is more configurable than the shell script that it replaces, and makes it clearer when looking at the makefile what it's acting on. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
3 years ago
bin/format-code.py \
--exclude-dir 'testing/googletest' \
--exclude-file 'generated-testcase.cpp' \
src plugins examples testing
Lift a bunch more project-specific stuff out of the generic makefile for sketches
4 years ago
Switch from astyle to clang-format for automated code formatting I added a `.clang-format` file to try to get as close as possible to our current code formatting. I also updated the makefile targets and the github workflows. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
3 years ago
check-formatting:
Replace clang-format wrapper script with something more configurable This python script is more configurable than the shell script that it replaces, and makes it clearer when looking at the makefile what it's acting on. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
3 years ago
bin/format-code.py \
--exclude-dir 'testing/googletest' \
--exclude-file 'generated-testcase.cpp' \
--check \
--verbose \
src plugins examples testing
Lift a bunch more project-specific stuff out of the generic makefile for sketches
4 years ago
cpplint-noisy:
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
-bin/cpplint.py --filter=-legal/copyright,-build/include,-readability/namespace,-whitespace/line_length,-runtime/references --recursive --extensions=cpp,h,ino src examples
Lift a bunch more project-specific stuff out of the generic makefile for sketches
4 years ago
cpplint:
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
bin/cpplint.py --quiet --filter=-whitespace,-legal/copyright,-build/include,-readability/namespace,-runtime/references --recursive --extensions=cpp,h,ino src examples
Lift a bunch more project-specific stuff out of the generic makefile for sketches
4 years ago
Use := syntax for when we call $(shell) in our makefiles. https://blog.melski.net/2010/11/15/shell-commands-in-gnu-make/ "In short: not using := assignment can cause your makefile to invoke the shell far more often than you realize, which can be a performance problem, and leave you with unpredictable build results. Always use := assignment with $(shell)."
3 years ago
SHELL_FILES := $(shell if [ -d bin ]; then egrep -n -r -l "(env (ba)?sh)|(/bin/(ba)?sh)" bin; fi)
Lift a bunch more project-specific stuff out of the generic makefile for sketches
4 years ago
shellcheck:
@if [ -d "bin" ]; then \
shellcheck ${SHELL_FILES}; \
fi
migrate check-docs from generic makefile
4 years ago
Use := syntax for when we call $(shell) in our makefiles. https://blog.melski.net/2010/11/15/shell-commands-in-gnu-make/ "In short: not using := assignment can cause your makefile to invoke the shell far more often than you realize, which can be a performance problem, and leave you with unpredictable build results. Always use := assignment with $(shell)."
3 years ago
SMOKE_SKETCHES := $(sort $(shell if [ -d ./examples ]; then find ./examples -type f -name \*ino | xargs -n 1 dirname; fi))
Move a bunch of makefile targets from the generic sketch makefile
4 years ago
smoke-sketches: $(SMOKE_SKETCHES)
@echo "Smoke-tested all the sketches"
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
.PHONY: force all clean test
clean:
$(MAKE) -C tests clean
rm -rf -- "testing/googletest/build/*"
rm -rf -- "_build/*"
Move a bunch of makefile targets from the generic sketch makefile
4 years ago
$(SMOKE_SKETCHES): force
Replace kaleidoscope-builder with makefiles using arduino-cli This is a complete rework of how Kaleidoscope is built, but should be largely transparent to most developers and completely invisible to folks using the Arduino IDE. Some advanced features of kaleidoscope-builder config files have gone away, but it’s likely that @algernon was the only person using them. The tradeoff is that we’re now using a much better maintained build tool under the hood and that we’re no longer as tied to a single specific directory structure.
4 years ago
$(MAKE) -C $@ -f $(KALEIDOSCOPE_ETC_DIR)/makefiles/sketch.mk compile
Add the version to the package tarball name so that nightlies have unique names add a make target for building arduino nightly packages
4 years ago
build-arduino-nightly-package:
perl bin/build-arduino-package \
--kaleidoscope-tag=master \
Remove leading zeros from month and day components of date based version to comply with semver spec Thanks to @The-Compiler for catching the issue
3 years ago
--version `date +%Y.%-m.%-d%H%M%S` \
Automatically publish a kaleidoscope bundle on every commit for Arduino users who want to live on the bleading edge
4 years ago
--index-filename-slug=kaleidoscope_master \
Add the version to the package tarball name so that nightlies have unique names add a make target for building arduino nightly packages
4 years ago
--only-one-platform-revision \
--push \
Automatically publish a kaleidoscope bundle on every commit for Arduino users who want to live on the bleading edge
4 years ago
--output-repo=ssh://git@github.com/keyboardio/arduino-kaleidoscope-master