Makefile

.all:

.PHONY: all doc doc-man doc-latex docclean doc-starlight print-versions welcome

all: welcome
	@echo ""
	@exit 1

doc doc-man doc-latex doc-ci:
	@./dist/tools/features_yaml2mx/features_yaml2mx.py \
		features.yaml \
		--output-md doc/doxygen/src/feature_list.md
	"$(MAKE)" -C doc/doxygen $@

doc-starlight:
	"$(MAKE)" -C doc/starlight dev

docclean:
	"$(MAKE)" -BC doc/doxygen clean
	"$(MAKE)" -C doc/starlight clean

pkg-clean:
	@echo "Cleaning all package sources"
	rm -rf build/pkg

print-versions:
	@./dist/tools/ci/print_toolchain_versions.sh

generate-features:
	@./dist/tools/features_yaml2mx/features_yaml2mx.py \
		features.yaml \
		--output-makefile makefiles/features_existing.inc.mk

include makefiles/boards.inc.mk
include makefiles/app_dirs.inc.mk

include makefiles/tools/riotgen.inc.mk
-include makefiles/tests.inc.mk

include makefiles/color.inc.mk

CLEAN_DIRS := $(APPLICATION_DIRS) $(TOOLS_DIRS)

.PHONY: clean distclean $(CLEAN_DIRS:%=CLEAN--%) $(CLEAN_DIRS:%=DISTCLEAN--%)
clean: $(CLEAN_DIRS:%=CLEAN--%)
	@echo "Cleaned all build products."

distclean: docclean pkg-clean $(CLEAN_DIRS:%=DISTCLEAN--%)
	@echo "Cleaned everything."

$(CLEAN_DIRS:%=CLEAN--%):
	-"$(MAKE)" -C $(@:CLEAN--%=%) clean

$(CLEAN_DIRS:%=DISTCLEAN--%):
	-"$(MAKE)" -C $(@:DISTCLEAN--%=%) distclean

# Prints a welcome message
define welcome_message
	@echo "Welcome to RIOT - The friendly OS for IoT!"
	@echo ""
	@echo "You executed 'make' from the base directory."
	@echo "Usually, you should run 'make' in your application's directory instead."
	@echo ""
	@echo "Please see our Quick Start Guide at:"
	@echo "    https://doc.riot-os.org/getting-started.html"
	@echo "You can ask questions or discuss with other users on our forum:"
	@echo "    https://forum.riot-os.org"
	@echo ""
	@echo "Available targets for the RIOT base directory include:"
	@echo " generate-{board,driver,example,module,pkg,test,features}"
	@echo " info-{applications,boards,emulated-boards} info-applications-supported-boards"
	@echo " print-versions"
	@echo " clean distclean docclean pkg-clean"
	@echo " doc doc-{starlight,man,latex}"
	@echo ""
	@echo "==> tl;dr Try running:"
	@echo "    cd examples/basic/default"
	@echo "    make BOARD=<INSERT_BOARD_NAME>"
endef

welcome:
	$(call welcome_message)

.DEFAULT:
	@echo '*** ERROR: unrecognized target "$@"'
	@echo ""
	$(call welcome_message)
	@exit 1