Skip to content

Instantly share code, notes, and snippets.

@rasheedamir
Forked from prwhite/Makefile
Created June 19, 2017 07:29
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save rasheedamir/9bc72021e0709d51ef0064a031ad1d88 to your computer and use it in GitHub Desktop.
Save rasheedamir/9bc72021e0709d51ef0064a031ad1d88 to your computer and use it in GitHub Desktop.
Add a help target to a Makefile that will allow all targets to be self documenting
# Add the following 'help' target to your Makefile
# And add help text after each target name starting with '\#\#'
help: ## Show this help.
@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
# Everything below is an example
target00: ## This message will show up when typing 'make help'
@echo does nothing
target01: ## This message will also show up when typing 'make help'
@echo does something
# Remember that targets can have multiple entries (if your target specifications are very long, etc.)
target02: ## This message will show up too!!!
target02: target00 target01
@echo does even more
@rasheedamir
Copy link
Author

look the comments of the forked file! they make it look awesome ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment