README: fix the slightly misleading doc #30
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`make proto` command runs protocol generation based on the tools installed on your local machine, which is not what really expected, because tools can be outdated. `make` calls a `make proto` from a container, so all tools are of the correct versions. This patch changes `make proto` to just `make`. Signed-off-by: Roman Penyaev <[email protected]>
|
Ping @eriknordmark @deitch |
deitch
reviewed
Oct 13, 2023
There was a problem hiding this comment.
This doesn't fit what I see in the Makefile:
proto-container:
docker build -f .devcontainer/Dockerfile -t eve-api-builder .
docker run --rm -v $(PWD):/src -w /src -u $$(id -u) eve-api-builder make proto
proto-diagram:
protodot -inc /usr/local/include -src ./proto/config/devconfig.proto -output devconfig -generated ./images
dot ./images/devconfig.dot -Tpng -o ./images/devconfig.png
dot ./images/devconfig.dot -Tsvg -o ./images/devconfig.svg
echo generated ./images/devconfig.*
.PHONY: proto-api-% proto proto-container
proto: go python proto-diagram
@echo Done building protobuf, you may want to vendor it into your packages, e.g. pkg/pillar.
@echo See ./go/README.md for more information.
The 'proto-container' is the first goal, which is the default for the make, so when you call 'make' you invoke the 'make proto-container'. |
|
Oh. Ok. It's a bit confusing. You're right about the flow. |
|
No idea why it won't let me review again. I'll just merge. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
make protocommand runs protocol generation based on the tools installed on your local machine, which is not what really expected, because tools can be outdated.makecalls amake protofrom a container, so all tools are of the correct versions.This patch changes
make prototo justmakein all docs.CC: @deitch