build: make checkstyle-* targets and cleanup
- Add new make targets:
checkstyle-commit
checkstyle-test (alias test-checkstyle)
checkstyle-all
test-wipe-papi (papi-wipe deprecated)
retest-all
retest-all-debug
install-deps (alias install-dep)
install-ext-dep (alias install-ext-deps)
- Fix .PHONY dependencies
- Cleanup redundant target commands
Type: refactor
Change-Id: I08b0ef459d421a09fb929aee5cd6baec329931b7
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
diff --git a/Makefile b/Makefile
index 7f5092b..dc7583e 100644
--- a/Makefile
+++ b/Makefile
@@ -165,12 +165,6 @@
TARGETS += sample-plugin
endif
-.PHONY: help wipe wipe-release build build-release rebuild rebuild-release
-.PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
-.PHONY: ctags cscope
-.PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
-.PHONY: test-cov test-wipe-cov
-
define banner
@echo "========================================================================"
@echo " $(1)"
@@ -178,9 +172,10 @@
@echo " "
endef
+.PHONY: help
help:
@echo "Make Targets:"
- @echo " install-dep - install software dependencies"
+ @echo " install-dep[s] - install software dependencies"
@echo " wipe - wipe all products of debug build "
@echo " wipe-release - wipe all products of release build "
@echo " build - build debug binaries"
@@ -202,6 +197,8 @@
@echo " test-wipe - wipe files generated by unit tests"
@echo " retest - run functional tests"
@echo " retest-debug - run functional tests (debug build)"
+ @echo " test-all - run functional and extended tests"
+ @echo " test-all-debug - run functional and extended tests (debug build)"
@echo " test-help - show help on test framework"
@echo " run-vat - run vpp-api-test tool"
@echo " pkg-deb - build DEB packages"
@@ -209,11 +206,13 @@
@echo " vom-pkg-deb - build vom DEB packages"
@echo " vom-pkg-deb-debug - build vom DEB debug packages"
@echo " pkg-rpm - build RPM packages"
- @echo " install-ext-deps - install external development dependencies"
+ @echo " install-ext-dep[s] - install external development dependencies"
@echo " ctags - (re)generate ctags database"
@echo " gtags - (re)generate gtags database"
@echo " cscope - (re)generate cscope database"
@echo " checkstyle - check coding style"
+ @echo " checkstyle-commit - check commit message format"
+ @echo " checkstyle-test - check test framework coding style"
@echo " fixstyle - fix coding style"
@echo " doxygen - (re)generate documentation"
@echo " bootstrap-doxygen - setup Doxygen dependencies"
@@ -229,6 +228,7 @@
@echo " test-wipe-doc - wipe documentation for test framework"
@echo " test-cov - generate code coverage report for test framework"
@echo " test-wipe-cov - wipe code coverage report for test framework"
+ @echo " test-wipe-papi - wipe test framework papi test code"
@echo " test-checkstyle - check PEP8 compliance for test framework"
@echo " test-refresh-deps - refresh the Python dependencies for the tests"
@echo ""
@@ -286,9 +286,11 @@
endif
@touch $@
+.PHONY: bootstrap
bootstrap:
@echo "'make bootstrap' is not needed anymore"
+.PHONY: install-dep
install-dep:
ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
ifeq ($(OS_VERSION_ID),14.04)
@@ -330,6 +332,9 @@
endif
git config commit.template .git_commit_template.txt
+.PHONY: install-deps
+install-deps: install-dep
+
define make
@make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
endef
@@ -344,6 +349,7 @@
DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
+.PHONY: dist
dist:
@if git rev-parse 2> /dev/null ; then \
git archive \
@@ -365,24 +371,31 @@
@$(RM) $(BR)/vpp-latest.tar.xz
@ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
+.PHONY: build
build: $(BR)/.deps.ok
$(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
+.PHONY: wipedist
wipedist:
@$(RM) $(BR)/*.tar.xz
+.PHONY: wipe
wipe: wipedist test-wipe $(BR)/.deps.ok
$(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
@find . -type f -name "*.api.json" ! -path "./test/*" -exec rm {} \;
+.PHONY: rebuild
rebuild: wipe build
+.PHONY: build-release
build-release: $(BR)/.deps.ok
$(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
+.PHONY: wipe-release
wipe-release: test-wipe $(BR)/.deps.ok
$(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
+.PHONY: rebuild-release
rebuild-release: wipe-release build-release
libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
@@ -406,72 +419,106 @@
$(3)
endef
+.PHONY: test
test:
$(call test,vpp,vpp,test)
+.PHONY: test-debug
test-debug:
$(call test,vpp,vpp_debug,test)
+.PHONY: test-gcov
test-gcov:
$(call test,vpp,vpp_gcov,test)
+.PHONY: test-all
test-all:
$(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp vom-install,)
$(eval EXTENDED_TESTS=yes)
$(call test,vpp,vpp,test)
+.PHONY: test-all-debug
test-all-debug:
$(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp_debug vom-install,)
$(eval EXTENDED_TESTS=yes)
$(call test,vpp,vpp_debug,test)
-papi-wipe:
+.PHONY: papi-wipe
+papi-wipe: test-wipe-papi
+ $(call banner,"This command is deprecated. Please use 'test-wipe-papi'")
+
+.PHONY: test-wipe-papi
+test-wipe-papi:
@make -C test papi-wipe
+.PHONY: test-help
test-help:
@make -C test help
+.PHONY: test-wipe
test-wipe:
@make -C test wipe
+.PHONY: test-shell
test-shell:
$(call test,vpp,vpp,shell)
+.PHONY: test-shell-debug
test-shell-debug:
$(call test,vpp,vpp_debug,shell)
+.PHONY: test-shell-gcov
test-shell-gcov:
$(call test,vpp,vpp_gcov,shell)
+.PHONY: test-dep
test-dep:
@make -C test test-dep
+.PHONY: test-doc
test-doc:
@make -C test doc
+.PHONY: test-wipe-doc
test-wipe-doc:
@make -C test wipe-doc
+.PHONY: test-cov
test-cov:
@make -C $(BR) PLATFORM=vpp TAG=vpp_gcov vom-install
$(eval EXTENDED_TESTS=yes)
$(call test,vpp,vpp_gcov,cov)
+.PHONY: test-wipe-cov
test-wipe-cov:
@make -C test wipe-cov
+.PHONY: test-checkstyle
test-checkstyle:
@make -C test checkstyle
+.PHONY: test-refresh-deps
test-refresh-deps:
@make -C test refresh-deps
+.PHONY: retest
retest:
$(call test,vpp,vpp,retest)
+.PHONY: retest-debug
retest-debug:
$(call test,vpp,vpp_debug,retest)
+.PHONY: retest-all
+retest-all:
+ $(eval EXTENDED_TESTS=yes)
+ $(call test,vpp,vpp,retest)
+
+.PHONY: retest-all-debug
+retest-all-debug:
+ $(eval EXTENDED_TESTS=yes)
+ $(call test,vpp,vpp_debug,retest)
+
ifeq ("$(wildcard $(STARTUP_CONF))","")
define run
@echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
@@ -493,80 +540,114 @@
.FORCE:
+.PHONY: run
run:
$(call run, $(BR)/install-$(PLATFORM)_debug-native)
+.PHONY: run-release
run-release:
$(call run, $(BR)/install-$(PLATFORM)-native)
+.PHONY: debug
debug:
$(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
+.PHONY: build-coverity
build-coverity:
$(call make,$(PLATFORM)_coverity,install-packages)
+.PHONY: debug-release
debug-release:
$(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
+.PHONY: build-vat
build-vat:
$(call make,$(PLATFORM)_debug,vpp-api-test-install)
+.PHONY: run-vat
run-vat:
@$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
+.PHONY: pkg-deb
pkg-deb:
$(call make,$(PLATFORM),vpp-package-deb)
-vom-pkg-deb:
- $(call make,$(PLATFORM),vpp-package-deb)
+.PHONY: vom-pkg-deb
+vom-pkg-deb: pkg-deb
$(call make,$(PLATFORM),vom-package-deb)
+.PHONY: pkg-deb-debug
pkg-deb-debug:
$(call make,$(PLATFORM)_debug,vpp-package-deb)
-vom-pkg-deb-debug:
- $(call make,$(PLATFORM)_debug,vpp-package-deb)
+.PHONY: vom-pkg-deb-debug
+vom-pkg-deb-debug: pkg-deb-debug
$(call make,$(PLATFORM)_debug,vom-package-deb)
+.PHONY: pkg-rpm
pkg-rpm: dist
make -C extras/rpm
+.PHONY: pkg-srpm
pkg-srpm: dist
make -C extras/rpm srpm
+.PHONY: dpdk-install-dev
dpdk-install-dev:
$(call banner,"This command is deprecated. Please use 'make install-ext-deps'")
make -C build/external install-$(PKG)
+.PHONY: install-ext-deps
install-ext-deps:
make -C build/external install-$(PKG)
+.PHONY: install-ext-dep
+install-ext-dep: install-ext-deps
+
+.PHONY: json-api-files
json-api-files:
$(WS_ROOT)/src/tools/vppapigen/generate_json.py
+.PHONY: json-api-files-debug
json-api-files-debug:
$(WS_ROOT)/src/tools/vppapigen/generate_json.py --debug-target
+.PHONY: ctags
ctags: ctags.files
@ctags --totals --tag-relative -L $<
@rm $<
+.PHONY: gtags
gtags: ctags
@gtags --gtagslabel=ctags
+.PHONY: cscope
cscope: cscope.files
@cscope -b -q -v
+.PHONY: checkstyle
checkstyle:
@build-root/scripts/checkstyle.sh
yamllint $(WS_ROOT)/src
+.PHONY: checkstyle-commit
+checkstyle-commit:
+ @extras/scripts/check_commit_msg.sh
+
+.PHONY: checkstyle-test
+checkstyle-test: test-checkstyle
+
+.PHONY: checkstyle-all
+checkstyle-all: checkstyle-commit checkstyle checkstyle-test
+
+.PHONY: fixstyle
fixstyle:
@build-root/scripts/checkstyle.sh --fix
# necessary because Bug 1696324 - Update to python3.6 breaks PyYAML dependencies
# Status: CLOSED CANTFIX
# https://bugzilla.redhat.com/show_bug.cgi?id=1696324
+.PHONY: centos-pyyaml
centos-pyyaml:
ifeq ($(OS_ID)-$(OS_VERSION_ID),centos-7)
@python3 -m pip install pyyaml
@@ -575,9 +656,11 @@
@sudo -E yum install $(CONFIRM) python3-pyyaml
endif
+.PHONY: featurelist
featurelist: centos-pyyaml
@build-root/scripts/fts.py --all --markdown
+.PHONY: checkfeaturelist
checkfeaturelist: centos-pyyaml
@build-root/scripts/fts.py --validate --git-status
@@ -592,14 +675,15 @@
@OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
endef
-.PHONY: bootstrap-doxygen doxygen wipe-doxygen
-
+.PHONY: bootstrap-doxygen
bootstrap-doxygen:
$(call make-doxy)
+.PHONY: doxygen
doxygen:
$(call make-doxy)
+.PHONY: wipe-doxygen
wipe-doxygen:
$(call make-doxy)
@@ -608,17 +692,19 @@
export VENV_DIR = $(WS_ROOT)/sphinx_venv
export SPHINX_SCRIPTS_DIR = $(WS_ROOT)/docs/scripts
-.PHONY: docs-venv docs docs-clean
-
+.PHONY: docs-venv
docs-venv:
@($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh venv)
+.PHONY: docs
docs: $(DOCS_DIR)
@($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh html)
+.PHONY: docs-clean
docs-clean:
@($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh clean)
+.PHONY: pkg-verify
pkg-verify: install-dep $(BR)/.deps.ok install-ext-deps
$(call banner,"Building for PLATFORM=vpp using gcc")
@make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
@@ -636,6 +722,7 @@
endif
MAKE_VERIFY_GATE_OS ?= ubuntu-18.04
+.PHONY: verify
verify: pkg-verify
ifeq ($(OS_ID)-$(OS_VERSION_ID),$(MAKE_VERIFY_GATE_OS))
$(call banner,"Testing vppapigen")