makefile 生成帮助信息

返回索引

代码片段

.PHONY: help
help: ## 查看帮助
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

使用

将片断复制到 Makefile 中，然后执行 make help 即可看到帮助信息。

如果片断放置于Makefile开始处，那么执行make时，会自动显示帮助信息。

帮助信息跟随代码，不需要单独维护。

帮助信息以注释的形式显示，不会影响makefile的执行。

代码片断会自动提取Makefile中以 ##开头注释，生成帮助信息。

显示效果如下：

$ make help
ansible-start                  启动ansible
clean                          清理项目,用于删除开发容器及存储卷,需在本地开发环境执行
docs-deploy                    部署文档
docs-dev                       启动文档服务
gitconfig                      初始化git配置
help                           查看帮助
init                           初始化环境变量
mysql-backup                   备份mysql
mysql-down                     停止mysql
mysql-up                       启动mysql
proxy-down                     停止代理
proxy-up                       启动代理
redis-down                     停止redis
redis-up                       启动redis
setmirror                      设置国内镜像源,用于在开发容器生成后配置国内镜像源,需在本地开发环境执行