| Joey Armstrong | 28eddda | 2023-01-10 03:09:34 -0500 | [diff] [blame] | 1 | # -*- makefile -*- |
| 2 | # ----------------------------------------------------------------------- |
| 3 | # Copyright 2017-2023 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 | # Parent makefile should include this early so help |
| 19 | # message will be prefixed by a usage statement. |
| 20 | help :: |
| 21 | @echo "Usage: $(MAKE) [options] [target] ..." |
| 22 | @echo |
| 23 | @echo '[Virtual Env]' |
| 24 | @echo ' venv Create a python virtual environment' |
| 25 | @echo " $(VENV_NAME)" |
| 26 | @echo |
| 27 | @echo '[CLEAN]' |
| 28 | @echo ' clean Remove generated targets' |
| 29 | @echo ' sterile clean + remove virtual env interpreter install' |
| 30 | @echo |
| 31 | @echo '[VIEW]' |
| 32 | @echo ' reload Setup to auto-reload sphinx doc changes in browser' |
| 33 | @echo ' view-html View generated documentation' |
| 34 | @echo |
| 35 | @echo '[TEST]' |
| 36 | @echo ' test make lint linkcheck' |
| 37 | @echo ' test-all make all-generation-targets' |
| 38 | @echo |
| 39 | @echo '[HELP]' |
| 40 | @echo ' help Display program help' |
| 41 | @echo ' help-verbose Display additional targets and help' |
| 42 | |
| 43 | # [EOF] |