Utility for self-documented Makefile
It scans Makefiles and shows rules with documents. It considers the comment line started with
double hash (##
) just before a rule is written as document of the rule.
Binaries are available.
https://github.com/Songmu/make2help/releases
You can also go get
.
% go get github.com/Songmu/make2help/cmd/make2help
% make2help
cover: Take coverage
deps: Install dependencies
dev-deps: Install dependencies
help: Show help
lint: Lint
release: Release the binaries
test: Run tests
-all display all rules in the Makefiles
With defining help
target in Makefile and setting it to .DEFAULT_GOAL
, you can see
help messages just type make
.
.DEFAULT_GOAL := help
## Run tests
test: deps
go test ./...
## Install dependencies
deps:
go get -d -v -t ./...
## Show help
help:
@make2help $(MAKEFILE_LIST)
.PHONY: test deps help
% make
deps: Install dependencies
help: Show help
test: Run tests