What is it?
make rule that allows pretty-printing short documentation for the
rules inside a Makefile:
How does it work?
Easy: simply copy everything starting at
.DEFAULT_GOAL := show-help to the end
of your own Makefile (or
include show-help-minified.make, and copy that file
into your project). Then document any rules by adding a single line starting
## immediately before the rule. E.g.:
## Run unit tests test: ./run-tests
Displaying the documentation is done by simply executing
make. This overrides
any previously set default command — you may not wish to do so; in that case,
simply remove the line that sets the
.DEFAULT_GOAL. You can then display the
make show-help. This makes it less discoverable, of course.