| Joey Armstrong | 73d3579 | 2022-11-25 08:46:46 -0500 | [diff] [blame] | 1 | # -*- makefile -*- |
| 2 | # ----------------------------------------------------------------------- |
| 3 | # Copyright 2022 Open Networking Foundation (ONF) and the ONF Contributors |
| 4 | # |
| 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. |
| 16 | # ----------------------------------------------------------------------- |
| 17 | |
| 18 | ## ----------------------------------------------------------------------- |
| 19 | ## ----------------------------------------------------------------------- |
| 20 | .PHONY: help |
| 21 | help :: # @HELP Print the command options |
| 22 | @echo |
| 23 | @echo -e "\033[0;31m BroadBand Simulator (BBSim) \033[0m" |
| 24 | @echo |
| 25 | @echo Emulates the control plane of an openolt compatible device |
| 26 | @echo Useful for development and scale testing |
| 27 | @echo |
| 28 | @grep -E '^.*: .* *# *@HELP' $(MAKEFILE_LIST) \ |
| 29 | | sort \ |
| 30 | | awk ' \ |
| 31 | BEGIN {FS = ": .* *# *@HELP"}; \ |
| 32 | {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}; \ |
| 33 | ' |
| 34 | |
| 35 | .PHONY: HELP |
| 36 | HELP: # @HELP Display extended makefile target help |
| 37 | @echo "Usage: $(MAKE) [options] [target] ..." |
| 38 | @echo |
| 39 | @echo "[DOCS] Generate documentation" |
| 40 | @echo " docs (alias) swagger" |
| 41 | @echo " swagger Generate swagger documentation for BBSIM API" |
| 42 | @echo |
| 43 | @echo "[LINT] - Invoke source linters" |
| 44 | @echo " docs-lint Lint generated docs" |
| 45 | @echo " lint (alias) lint-dockerfile, lint-mod" |
| 46 | @echo " lint-dockerfile" |
| 47 | @echo " lint-mod Golang module verify" |
| 48 | @echo " sca Static code analysis" |
| 49 | @echo |
| 50 | @echo "[SETUP]" |
| 51 | @echo " setup_tools Install module dependencies" |
| 52 | @echo |
| 53 | @echo "[BUILD]" |
| 54 | @echo |
| 55 | @echo "[RELEASE]" |
| 56 | @echo |
| 57 | @echo "[CLEAN]" |
| 58 | @echo " clean Remove generated targets" |
| 59 | @echo |
| 60 | |
| 61 | ## ----------------------------------------------------------------------- |
| 62 | ## ---------------------------------------------------------------------- |
| 63 | .PHONY: help-all |
| 64 | help-all : help HELP |
| 65 | |
| 66 | # [EOF] |