Skip to content

Makefile: add help target to display available targets #28845

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Feb 5, 2024
Merged

Makefile: add help target to display available targets #28845

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3790999
chore: add make help to display the usage for project Makefile
Halimao Jan 20, 2024
bc6234a
Update Makefile
Halimao Jan 20, 2024
f56ec6f
Update Makefile
Halimao Jan 20, 2024
4390b4e
Update Makefile
Halimao Jan 20, 2024
9e32966
Merge branch 'ethereum:master' into refactor/make-help
Halimao Jan 25, 2024
2a49746
Update Makefile
fjl Jan 25, 2024
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
13 changes: 13 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,45 @@
GOBIN = ./build/bin
GO ?= latest
GORUN = go run
PROJECT_NAME = $(shell git remote get-url origin | xargs basename -s .git)

#? geth: Build geth
geth:
$(GORUN) build/ci.go install ./cmd/geth
@echo "Done building."
@echo "Run \"$(GOBIN)/geth\" to launch geth."

#? all: Build all packages and executables, include abidump, abigen, bootnode, clef, devp2p, ethkey, evm, geth, p2psim, rlpdump
all:
$(GORUN) build/ci.go install

#? test: Run the tests
test: all
$(GORUN) build/ci.go test

#? lint: Run certain pre-selected linters
lint: ## Run linters.
$(GORUN) build/ci.go lint

#? clean: Clean go cache and built excutebles, and the auto generated folder
clean:
go clean -cache
rm -fr build/_workspace/pkg/ $(GOBIN)/*

# The devtools target installs tools required for 'go generate'.
# You need to put $GOBIN (or $GOPATH/bin) in your PATH to use 'go generate'.

#? devtools: Install pre-requirement developer tools
devtools:
env GOBIN= go install golang.org/x/tools/cmd/stringer@latest
env GOBIN= go install github.com/fjl/gencodec@latest
env GOBIN= go install github.com/golang/protobuf/protoc-gen-go@latest
env GOBIN= go install ./cmd/abigen
@type "solc" 2> /dev/null || echo 'Please install solc'
@type "protoc" 2> /dev/null || echo 'Please install protoc'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if/why protoc is a requirement. I don't have it, have never had any problem generating or building

Copy link
Contributor Author

@Halimao Halimao Jan 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about Install recommended developer tools?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The devtools target is for stuff that is required for go generate to work. We need protoc for generating the Trezor USB interface bindings.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The target is actually a bit outdated because we track go-based tools differently now. They no longer need to be installed because we use go run in the //go:generate line. I'm also not sure we need the Solidity compiler anymore, because all the contract bindings have been removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@holiman @fjl Hi sir, is there something else that needs to be added?

If I understand this correctly, we could try to remove the devtools target, and check if this will affect the new developer to initialize their development environment.


#? help: Get more info on make commands.
help: Makefile
@echo " Choose a command run in "$(PROJECT_NAME)":"
@sed -n 's/^#?//p' $< | column -t -s ':' | sort | sed -e 's/^/ /'
.PHONY: help