blob: 81fd3d796ebfd5276cab9e17ff651e2d8124c3c7 [file] [log] [blame]
Joey Armstrong28eddda2023-01-10 03:09:34 -05001# -*- 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.
20help ::
21 @echo "Usage: $(MAKE) [options] [target] ..."
22 @echo
23 @echo '[Virtual Env]'
24 @echo ' venv Create a python virtual environment'
Joey Armstrong7adbfb02023-01-24 17:02:37 -050025ifdef VENV_NAME
26 @echo " VENV_NAME=$(VENV_NAME)"
27endif
Joey Armstrong28eddda2023-01-10 03:09:34 -050028 @echo
29 @echo '[CLEAN]'
30 @echo ' clean Remove generated targets'
31 @echo ' sterile clean + remove virtual env interpreter install'
32 @echo
33 @echo '[VIEW]'
34 @echo ' reload Setup to auto-reload sphinx doc changes in browser'
35 @echo ' view-html View generated documentation'
36 @echo
37 @echo '[TEST]'
38 @echo ' test make lint linkcheck'
39 @echo ' test-all make all-generation-targets'
40 @echo
41 @echo '[HELP]'
42 @echo ' help Display program help'
43 @echo ' help-verbose Display additional targets and help'
44
45# [EOF]