Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 1 | # -*- makefile -*- |
| 2 | # -----------------------------------------------------------------------# |
| 3 | # Copyright 2016-2023 Open Networking Foundation (ONF) and the ONF Contributors |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 4 | # |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 5 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | # you may not use this file except in compliance with the License. |
| 7 | # You may obtain a copy of the License at |
| 8 | # |
| 9 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | # See the License for the specific language governing permissions and |
| 15 | # limitations under the License. |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 16 | # ----------------------------------------------------------------------- |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 17 | |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 18 | $(if $(DEBUG),$(warning ENTER)) |
| 19 | |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 20 | .DEFAULT_GOAL := help |
| 21 | |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 22 | $(if $(VERBOSE),$(eval export VERBOSE=$(VERBOSE))) # visible to include(s) |
| 23 | |
| 24 | ##--------------------## |
| 25 | ##---] INCLUDES [---## |
| 26 | ##--------------------## |
Joey Armstrong | 367d76b | 2023-06-08 17:16:46 -0400 | [diff] [blame] | 27 | -include config.mk |
| 28 | include makefiles/include.mk |
Kent Hagerman | 074d0e0 | 2019-04-24 17:58:16 -0400 | [diff] [blame] | 29 | |
Zack Williams | 27f59a4 | 2019-05-10 09:12:07 -0700 | [diff] [blame] | 30 | # Variables |
Kent Hagerman | f4a3aab | 2019-05-22 14:42:34 -0400 | [diff] [blame] | 31 | VERSION ?= $(shell cat ./VERSION) |
Zack Williams | 27f59a4 | 2019-05-10 09:12:07 -0700 | [diff] [blame] | 32 | |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 33 | # Packages |
| 34 | PACKAGES = $(shell go list ./...) |
| 35 | |
Kent Hagerman | f4a3aab | 2019-05-22 14:42:34 -0400 | [diff] [blame] | 36 | DOCKER_LABEL_VCS_DIRTY = false |
| 37 | ifneq ($(shell git ls-files --others --modified --exclude-standard 2>/dev/null | wc -l | sed -e 's/ //g'),0) |
| 38 | DOCKER_LABEL_VCS_DIRTY = true |
| 39 | endif |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 40 | |
Matt Jeanneret | 2e3051a | 2019-05-11 15:01:46 -0400 | [diff] [blame] | 41 | ## Docker related |
David K. Bainbridge | e14914d | 2019-05-24 13:43:05 -0700 | [diff] [blame] | 42 | DOCKER_EXTRA_ARGS ?= |
Kent Hagerman | f4a3aab | 2019-05-22 14:42:34 -0400 | [diff] [blame] | 43 | DOCKER_REGISTRY ?= |
| 44 | DOCKER_REPOSITORY ?= |
| 45 | DOCKER_TAG ?= ${VERSION}$(shell [[ ${DOCKER_LABEL_VCS_DIRTY} == "true" ]] && echo "-dirty" || true) |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 46 | DOCKER_TARGET ?= prod |
Kent Hagerman | f4a3aab | 2019-05-22 14:42:34 -0400 | [diff] [blame] | 47 | RWCORE_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-rw-core |
Andrea Campanella | 7a6cce2 | 2019-12-17 14:10:27 -0800 | [diff] [blame] | 48 | TYPE ?= minimal |
Matt Jeanneret | 2e3051a | 2019-05-11 15:01:46 -0400 | [diff] [blame] | 49 | |
| 50 | ## Docker labels. Only set ref and commit date if committed |
Kent Hagerman | f4a3aab | 2019-05-22 14:42:34 -0400 | [diff] [blame] | 51 | DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote)) |
| 52 | DOCKER_LABEL_VCS_REF = $(shell git rev-parse HEAD) |
| 53 | DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ") |
| 54 | DOCKER_LABEL_COMMIT_DATE = $(shell git show -s --format=%cd --date=iso-strict HEAD) |
Matt Jeanneret | 2e3051a | 2019-05-11 15:01:46 -0400 | [diff] [blame] | 55 | |
Kent Hagerman | f4a3aab | 2019-05-22 14:42:34 -0400 | [diff] [blame] | 56 | DOCKER_BUILD_ARGS ?= \ |
David K. Bainbridge | e14914d | 2019-05-24 13:43:05 -0700 | [diff] [blame] | 57 | ${DOCKER_EXTRA_ARGS} \ |
Kent Hagerman | f4a3aab | 2019-05-22 14:42:34 -0400 | [diff] [blame] | 58 | --build-arg org_label_schema_version="${VERSION}" \ |
| 59 | --build-arg org_label_schema_vcs_url="${DOCKER_LABEL_VCS_URL}" \ |
| 60 | --build-arg org_label_schema_vcs_ref="${DOCKER_LABEL_VCS_REF}" \ |
| 61 | --build-arg org_label_schema_build_date="${DOCKER_LABEL_BUILD_DATE}" \ |
| 62 | --build-arg org_opencord_vcs_commit_date="${DOCKER_LABEL_COMMIT_DATE}" \ |
| 63 | --build-arg org_opencord_vcs_dirty="${DOCKER_LABEL_VCS_DIRTY}" |
| 64 | |
| 65 | DOCKER_BUILD_ARGS_LOCAL ?= ${DOCKER_BUILD_ARGS} \ |
Kent Hagerman | f4a3aab | 2019-05-22 14:42:34 -0400 | [diff] [blame] | 66 | --build-arg LOCAL_PROTOS=${LOCAL_PROTOS} |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 67 | |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 68 | .PHONY: docker-build local-protos local-lib-go help |
| 69 | .DEFAULT_GOAL := help |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 70 | |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 71 | |
David K. Bainbridge | 1678e19 | 2019-05-17 11:48:29 -0700 | [diff] [blame] | 72 | ## Local Development Helpers |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 73 | local-protos: ## Copies a local version of the voltha-protos dependency into the vendor directory |
David K. Bainbridge | 1678e19 | 2019-05-17 11:48:29 -0700 | [diff] [blame] | 74 | ifdef LOCAL_PROTOS |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 75 | $(RM) -r vendor/github.com/opencord/voltha-protos/v5/go |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 76 | mkdir -p vendor/github.com/opencord/voltha-protos/v5/go |
| 77 | cp -r ${LOCAL_PROTOS}/go/* vendor/github.com/opencord/voltha-protos/v5/go |
David K. Bainbridge | 1678e19 | 2019-05-17 11:48:29 -0700 | [diff] [blame] | 78 | endif |
| 79 | |
Scott Baker | cb7c88a | 2019-10-16 18:32:48 -0700 | [diff] [blame] | 80 | ## Local Development Helpers |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 81 | local-lib-go: ## Copies a local version of the voltha-lib-go dependency into the vendor directory |
Scott Baker | cb7c88a | 2019-10-16 18:32:48 -0700 | [diff] [blame] | 82 | ifdef LOCAL_LIB_GO |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 83 | $(RM) -r vendor/github.com/opencord/voltha-lib-go/v7/pkg |
khenaidoo | d948f77 | 2021-08-11 17:49:24 -0400 | [diff] [blame] | 84 | mkdir -p vendor/github.com/opencord/voltha-lib-go/v7/pkg |
| 85 | cp -r ${LOCAL_LIB_GO}/pkg/* vendor/github.com/opencord/voltha-lib-go/v7/pkg/ |
Scott Baker | cb7c88a | 2019-10-16 18:32:48 -0700 | [diff] [blame] | 86 | endif |
| 87 | |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 88 | ## ----------------------------------------------------------------------- |
Matt Jeanneret | 2e3051a | 2019-05-11 15:01:46 -0400 | [diff] [blame] | 89 | ## Docker targets |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 90 | ## ----------------------------------------------------------------------- |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 91 | build: docker-build ## Alias for 'docker-build' |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 92 | |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 93 | docker-build-args += --debug |
| 94 | docker-build-args += --log-level 'debug' |
| 95 | docker-build-args := $(null)# comment line for debug mode |
| 96 | |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 97 | docker-build: local-protos local-lib-go ## Build core docker image (set BUILD_PROFILED=true to also build the profiled image) |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 98 | |
| 99 | $(call banner-enter,$@) |
| 100 | $(MAKE) --no-print-directory test-coverage-init |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 101 | |
| 102 | docker $(docker-build-args) build $(DOCKER_BUILD_ARGS) -t ${RWCORE_IMAGENAME}:${DOCKER_TAG} --target ${DOCKER_TARGET} -f docker/Dockerfile.rw_core . |
Matteo Scandolo | 450933a | 2020-04-30 07:47:08 -0700 | [diff] [blame] | 103 | ifdef BUILD_PROFILED |
Andrea Campanella | 8d4f3e3 | 2021-04-13 10:02:03 +0200 | [diff] [blame] | 104 | # Force target to dev as profile build must be built with dynamic linking |
| 105 | docker build $(DOCKER_BUILD_ARGS) --target dev --build-arg EXTRA_GO_BUILD_TAGS="-tags profile" --build-arg CGO_PARAMETER="CGO_ENABLED=1" -t ${RWCORE_IMAGENAME}:${DOCKER_TAG}-profile -f docker/Dockerfile.rw_core . |
Matteo Scandolo | 450933a | 2020-04-30 07:47:08 -0700 | [diff] [blame] | 106 | endif |
David K. Bainbridge | 3768fde | 2020-07-29 21:15:35 -0700 | [diff] [blame] | 107 | ifdef BUILD_RACE |
Andrea Campanella | 8d4f3e3 | 2021-04-13 10:02:03 +0200 | [diff] [blame] | 108 | # Force target to dev as race detection build must be built with dynamic linking |
| 109 | docker build $(DOCKER_BUILD_ARGS) --target dev --build-arg GOLANG_IMAGE=golang:1.13.8-buster --build-arg CGO_PARAMETER="CGO_ENABLED=1" --build-arg DEPLOY_IMAGE=debian:buster-slim --build-arg EXTRA_GO_BUILD_TAGS="--race" -t ${RWCORE_IMAGENAME}:${DOCKER_TAG}-rd -f docker/Dockerfile.rw_core . |
David K. Bainbridge | 3768fde | 2020-07-29 21:15:35 -0700 | [diff] [blame] | 110 | endif |
Don Newton | 8eca462 | 2020-02-10 16:44:48 -0500 | [diff] [blame] | 111 | |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 112 | $(call banner-leave,$@) |
| 113 | |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 114 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 5f51f2e | 2023-01-17 17:06:26 -0500 | [diff] [blame] | 115 | ## Intent: |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 116 | ## ----------------------------------------------------------------------- |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 117 | docker-push: ## Push the docker images to an external repository |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 118 | |
| 119 | $(call banner-enter,$@) |
| 120 | |
Jan Klare | 07d5bb1 | 2023-11-01 14:55:42 +0100 | [diff] [blame] | 121 | docker push ${RWCORE_IMAGENAME}:${DOCKER_TAG} |
Matteo Scandolo | 8ed186a | 2020-05-04 10:52:42 -0700 | [diff] [blame] | 122 | ifdef BUILD_PROFILED |
| 123 | docker push ${RWCORE_IMAGENAME}:${DOCKER_TAG}-profile |
| 124 | endif |
David K. Bainbridge | 3768fde | 2020-07-29 21:15:35 -0700 | [diff] [blame] | 125 | ifdef BUILD_RACE |
| 126 | docker push ${RWCORE_IMAGENAME}:${DOCKER_TAG}-rd |
| 127 | endif |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 128 | docker-kind-load: ## Load docker images into a KinD cluster |
Andrea Campanella | 7a6cce2 | 2019-12-17 14:10:27 -0800 | [diff] [blame] | 129 | @if [ "`kind get clusters | grep voltha-$(TYPE)`" = '' ]; then echo "no voltha-$(TYPE) cluster found" && exit 1; fi |
| 130 | kind load docker-image ${RWCORE_IMAGENAME}:${DOCKER_TAG} --name=voltha-$(TYPE) --nodes $(shell kubectl get nodes --template='{{range .items}}{{.metadata.name}},{{end}}' | rev | cut -c 2- | rev) |
Andrea Campanella | 7a6cce2 | 2019-12-17 14:10:27 -0800 | [diff] [blame] | 131 | |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 132 | $(call banner-leave,$@) |
| 133 | |
| 134 | ## ----------------------------------------------------------------------- |
Matt Jeanneret | 2e3051a | 2019-05-11 15:01:46 -0400 | [diff] [blame] | 135 | ## lint and unit tests |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 136 | ## ----------------------------------------------------------------------- |
| 137 | |
| 138 | # [TODO] |
| 139 | # o Merge lint-* targets with repo:openolt-adapter/Makefile |
khenaidoo | d2b6df9 | 2018-12-13 16:37:20 -0500 | [diff] [blame] | 140 | |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 141 | lint-dockerfile: ## Perform static analysis on Dockerfile |
Kent Hagerman | dcd4dcc | 2020-02-25 17:56:17 -0500 | [diff] [blame] | 142 | @echo "Running Dockerfile lint check..." |
Kent Hagerman | 812b257 | 2020-01-28 11:57:51 -0500 | [diff] [blame] | 143 | @${HADOLINT} $$(find . -name "Dockerfile.*") |
David Bainbridge | 5f3619c | 2019-07-10 22:51:09 +0000 | [diff] [blame] | 144 | @echo "Dockerfile lint check OK" |
| 145 | |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 146 | lint-mod: ## Verify the Go dependencies |
Kent Hagerman | ca4c51e | 2019-05-02 12:28:55 -0400 | [diff] [blame] | 147 | @echo "Running dependency check..." |
Kent Hagerman | 812b257 | 2020-01-28 11:57:51 -0500 | [diff] [blame] | 148 | @${GO} mod verify |
Scott Baker | e4c2a98 | 2019-11-21 16:32:03 -0800 | [diff] [blame] | 149 | @echo "Dependency check OK. Running vendor check..." |
| 150 | @git status > /dev/null |
Kent Hagerman | dcd4dcc | 2020-02-25 17:56:17 -0500 | [diff] [blame] | 151 | @git diff-index --quiet HEAD -- go.mod go.sum vendor || (echo "ERROR: Staged or modified files must be committed before running this test" && git status -- go.mod go.sum vendor && exit 1) |
| 152 | @[[ `git ls-files --exclude-standard --others go.mod go.sum vendor` == "" ]] || (echo "ERROR: Untracked files must be cleaned up before running this test" && git status -- go.mod go.sum vendor && exit 1) |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 153 | |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 154 | $(MAKE) mod-update |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 155 | |
Scott Baker | e4c2a98 | 2019-11-21 16:32:03 -0800 | [diff] [blame] | 156 | @git status > /dev/null |
Kent Hagerman | dcd4dcc | 2020-02-25 17:56:17 -0500 | [diff] [blame] | 157 | @git diff-index --quiet HEAD -- go.mod go.sum vendor || (echo "ERROR: Modified files detected after running go mod tidy / go mod vendor" && git status -- go.mod go.sum vendor && git checkout -- go.mod go.sum vendor && exit 1) |
| 158 | @[[ `git ls-files --exclude-standard --others go.mod go.sum vendor` == "" ]] || (echo "ERROR: Untracked files detected after running go mod tidy / go mod vendor" && git status -- go.mod go.sum vendor && git checkout -- go.mod go.sum vendor && exit 1) |
Scott Baker | e4c2a98 | 2019-11-21 16:32:03 -0800 | [diff] [blame] | 159 | @echo "Vendor check OK." |
| 160 | |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 161 | ## ----------------------------------------------------------------------- |
| 162 | ## ----------------------------------------------------------------------- |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 163 | lint: lint-mod lint-dockerfile ## Run all lint targets |
Kent Hagerman | 074d0e0 | 2019-04-24 17:58:16 -0400 | [diff] [blame] | 164 | |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 165 | include $(MAKEDIR)/analysis/include.mk |
Scott Baker | 18ea5a4 | 2019-10-15 16:08:42 -0700 | [diff] [blame] | 166 | |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 167 | ## ----------------------------------------------------------------------- |
| 168 | ## ----------------------------------------------------------------------- |
| 169 | tests-dir := ./tests/results |
| 170 | tests-coverage := $(tests-dir)/go-test-coverage |
| 171 | tests-results := $(tests-dir)/go-test-results |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 172 | |
| 173 | test :: test-coverage ## Run unit tests |
| 174 | test-coverage : local-lib-go |
Kent Hagerman | 074d0e0 | 2019-04-24 17:58:16 -0400 | [diff] [blame] | 175 | |
Joey Armstrong | 367d76b | 2023-06-08 17:16:46 -0400 | [diff] [blame] | 176 | clean :: distclean ## Removes any local filesystem artifacts generated by a build |
David K. Bainbridge | 1678e19 | 2019-05-17 11:48:29 -0700 | [diff] [blame] | 177 | |
Joey Armstrong | 367d76b | 2023-06-08 17:16:46 -0400 | [diff] [blame] | 178 | distclean sterile :: ## Removes any local filesystem artifacts generated by a build or test run |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 179 | $(RM) -r ./sca-report |
David K. Bainbridge | 1678e19 | 2019-05-17 11:48:29 -0700 | [diff] [blame] | 180 | |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 181 | fmt: ## Formats the soure code to go best practice style |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 182 | # gofmt -s -w $(PACKAGES) |
Maninder | 9a1bc0d | 2020-10-26 11:34:02 +0530 | [diff] [blame] | 183 | @go fmt ${PACKAGES} |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 184 | |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 185 | ## ----------------------------------------------------------------------- |
| 186 | ## ----------------------------------------------------------------------- |
| 187 | .PHONY: mod-update |
| 188 | mod-update: mod-tidy mod-vendor |
| 189 | |
| 190 | ## ----------------------------------------------------------------------- |
| 191 | ## ----------------------------------------------------------------------- |
| 192 | .PHONY: mod-tidy |
| 193 | mod-tidy: |
| 194 | $(call banner-enter,$@) |
| 195 | ${GO} mod tidy |
| 196 | $(call banner-leave,$@) |
| 197 | |
| 198 | ## ----------------------------------------------------------------------- |
| 199 | ## Intent: Refresh vendor/ directory package source |
| 200 | ## ----------------------------------------------------------------------- |
| 201 | ## Note: This target is destructive, vendor/ directory will be removed. |
| 202 | ## Todo: Update logic to checkout version on demand VS checkin a static |
| 203 | ## copy of vendor/ sources then augment. Logically removal of |
| 204 | ## files under revision control is strange. |
| 205 | ## ----------------------------------------------------------------------- |
| 206 | .PHONY: mod-vendor |
| 207 | mod-vendor: |
| 208 | $(call banner-enter,$@) |
| 209 | @$(if $(LOCAL_FIX_PERMS),chmod 777 .) |
| 210 | ${GO} mod vendor |
| 211 | @$(if $(LOCAL_FIX_PERMS),chmod 755 .) |
| 212 | $(call banner-leave,$@) |
| 213 | |
| 214 | ## ----------------------------------------------------------------------- |
| 215 | ## ----------------------------------------------------------------------- |
| 216 | help :: |
| 217 | @echo '[MOD UPDATE]' |
| 218 | @echo ' mod-update' |
| 219 | @echo ' LOCAL_FIX_PERMS=1 Hack to fix docker filesystem access problems' |
| 220 | @echo ' mod-tidy' |
| 221 | @echo ' mod-vendor' |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 222 | |
| 223 | ## --------------------------------------------------------------------------- |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 224 | # For each makefile target, add ## <description> on the target line and it will be listed by 'make help' |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 225 | ## --------------------------------------------------------------------------- |
Joey Armstrong | 367d76b | 2023-06-08 17:16:46 -0400 | [diff] [blame] | 226 | help :: ## Print help for each Makefile target |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 227 | @echo "Usage: make [<target>]" |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 228 | @echo " help This message" |
| 229 | @echo " todo Future enhancements" |
| 230 | @echo " versions Display version-by-tool used while building" |
| 231 | ifdef VERBOSE |
David K. Bainbridge | 4183514 | 2021-04-01 17:26:12 +0000 | [diff] [blame] | 232 | @echo |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 233 | endif |
| 234 | @echo |
| 235 | @grep --no-filename '^[[:alpha:]_-]*:.* ##' $(MAKEFILE_LIST) \ |
| 236 | | sort \ |
| 237 | | awk 'BEGIN {FS=":.* ## "}; {printf "%-25s : %s\n", $$1, $$2};' |
| 238 | |
Joey Armstrong | 393daca | 2023-07-06 08:47:54 -0400 | [diff] [blame] | 239 | $(if $(DEBUG),$(warning LEAVE)) |
| 240 | |
Joey Armstrong | 811e954 | 2022-12-25 21:45:27 -0500 | [diff] [blame] | 241 | # [EOF] |