Makefile: add make help

We've got a lot of top level Makefile targets, help out the user.

Signed-off-by: Joe Lawrence <joe.lawrence@redhat.com>
This commit is contained in:
Joe Lawrence 2022-05-23 08:47:18 -04:00
parent b6b650a006
commit 02306e62ae
1 changed files with 22 additions and 0 deletions

View File

@ -15,6 +15,7 @@ CLEAN_DIRS += clean-$(UNITTEST_DIR)
.PHONY: integration integration-slow integration-quick
.PHONY: vagrant-integration-slow vagrant-integration-quick vagrant-integration
.PHONY: vagrant-install
.PHONY: help
all: $(BUILD_DIRS)
@ -71,3 +72,24 @@ check:
test/integration/lib.sh test/integration/rebase-patches \
test/integration/test-vagrant \
test/integration/vm-integration-run
help:
@echo "kpatch Makefile"
@echo
@echo "Targets:"
@echo " make dependencies install build dependencies [1]"
@echo " make all build entire project"
@echo " make install install programs to system [1]"
@echo " make uninstall remove programs from system [1]"
@echo " make clean clean build files"
@echo
@echo "Test targets:"
@echo " make check run static code analyzers"
@echo " make integration build and run integration tests [2]"
@echo " make integration-slow build and run integration tests [2]"
@echo " make integration-quick build and run integration tests [2]"
@echo " make unit run unit tests"
@echo
@echo "[1] requires admin privileges"
@echo "[2] installs test kpatch kernel modules, run at your own risk"
@echo