[skywalking-showcase] 11/12: Add usage for make help

[ke...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kezhenxu94 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-showcase.git

commit a6c257b0c569e429fd8fc755aa36c6f9eaac5213
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Thu Nov 4 11:46:45 2021 +0800

    Add usage for make help
---
 ...ker-compose.agents.yaml => docker-compose.agent.yaml} |  0
 scripts/make/help.mk                                     | 16 ++++++++++++++++
 2 files changed, 16 insertions(+)

diff --git a/deploy/platform/docker/docker-compose.agents.yaml b/deploy/platform/docker/docker-compose.agent.yaml
similarity index 100%
rename from deploy/platform/docker/docker-compose.agents.yaml
rename to deploy/platform/docker/docker-compose.agent.yaml
diff --git a/scripts/make/help.mk b/scripts/make/help.mk
index 8919cec..2e9cc27 100644
--- a/scripts/make/help.mk
+++ b/scripts/make/help.mk
@@ -1,7 +1,23 @@
 ##@ Other targets
 
+define usage
+  You can customize the settings in Makefile.in
+  by specifying the variable in make command:
+
+  $$ make deploy.docker FEATURE_FLAGS=agent,vm
+
+  or via environment variable:
+
+  $$ export FEATURE_FLAGS=agent,vm && make deploy.docker
+endef
+
+export usage
+
 .PHONY: help
 help:  ## Display this help
+	@echo ''
+	@echo 'Usage:'
+	@echo "$$usage"
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} \
 			/^[.a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m \t%s\n", $$1, $$2 } \
 			/^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) }' $(MAKEFILE_LIST)