tomekc/makefile_help.md

Created May 17, 2022 09:53

Star () You must be signed in to star a gist
Fork () You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/tomekc/d8212ed972d14828655d1b3ba52627fb.js"></script>
Save tomekc/d8212ed972d14828655d1b3ba52627fb to your computer and use it in GitHub Desktop.

Download ZIP

Makefile help

Raw

makefile_help.md

Default "help" target in Makefile

GREEN  := $(shell tput -Txterm setaf 2)
YELLOW := $(shell tput -Txterm setaf 3)
WHITE  := $(shell tput -Txterm setaf 7)
RESET  := $(shell tput -Txterm sgr0)

.PHONY: help
help: ## Show this help.
	@echo 'Usage:'
	@echo '  ${YELLOW}make${RESET} ${GREEN}<target>${RESET}'
	@echo ''
	@echo 'Targets:'
	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "  ${YELLOW}%-28s${GREEN}%s${RESET}\n", $$1, $$2}' $(MAKEFILE_LIST)

Add comments to targets:

test: ## Run tests
   run-tests-command