blob: 3cca2cdf28fac9fca7f9d245cfb3b0d4410b5b43 [file] [log] [blame]
Joey Armstrong36592e32022-11-28 09:00:28 -05001# -*- makefile -*-
2# -----------------------------------------------------------------------
Joey Armstrong8d62cd92022-12-22 13:53:48 -05003# Copyright 2017-2023 Open Networking Foundation (ONF) and the ONF Contributors
Joey Armstrong36592e32022-11-28 09:00:28 -05004#
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
Joey Armstrongf88b7382022-12-02 15:04:21 -050023 @echo '[Virtual Env]'
Joey Armstronga8bc8e12022-12-04 07:06:59 -050024 @echo ' venv Create a python virtual environment'
Joey Armstrongf88b7382022-12-02 15:04:21 -050025 @echo " $(VENV_NAME)"
26 @echo
Joey Armstrong36592e32022-11-28 09:00:28 -050027 @echo '[CLEAN]'
28 @echo ' clean Remove generated targets'
29 @echo ' sterile clean + remove virtual env interpreter install'
30 @echo
Joey Armstronga8bc8e12022-12-04 07:06:59 -050031 @echo '[VIEW]'
32 @echo ' reload Setup to auto-reload sphinx doc changes in browser'
33 @echo ' view-html View generated documentation'
34 @echo
Joey Armstrong8d62cd92022-12-22 13:53:48 -050035 @echo '[TEST]'
36 @echo ' test make lint linkcheck'
37 @echo ' test-all make all-generation-targets'
38 @echo
Joey Armstrong36592e32022-11-28 09:00:28 -050039 @echo '[HELP]'
40 @echo ' help Display program help'
41 @echo ' help-verbose Display additional targets and help'
42
43# [EOF]