Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add help command to Makefile for improved usability #2809

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,22 @@ check:
docker run --rm -v `pwd`:/app -w /app docker.io/golangci/golangci-lint:$(GOLANGCILINT_WANT_VERSION) golangci-lint run
endif

.PHONY: $(TARGET) release local-release install clean test bench check clean-tags tags
.PHONY: $(TARGET) release local-release install clean test bench check clean-tags tags help

help:
@echo "Available commands:"
@printf " %-18s Build the Cilium binary.\n" $(TARGET)
@printf " %-18s Create a release of the binary.\n" release
@printf " %-18s Build binaries for local environment.\n" local-release
@printf " %-18s Install the Cilium binary.\n" install
@printf " %-18s Remove the binary and release files.\n" clean
@printf " %-18s Run tests with race detection and coverage.\n" test
@printf " %-18s Run benchmarks.\n" bench
@printf " %-18s Run lint checks on the code.\n" check
@printf " %-18s Remove generated tags and cscope files.\n" clean-tags
@printf " %-18s Generate tags for the source code.\n" tags
@echo ""
@echo "Run 'make <command>' to execute a command."
@echo "Use 'make help' to see this help message."

-include Makefile.override
Loading