-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
llb: update docs #293
llb: update docs #293
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why make it top level as nobody really needs to import this package directly. How about client/llb/pb
?
llb/llb.proto
Outdated
message SourceOp { | ||
// source type? | ||
// identifier e.g. local://, docker-image://, git://, https://... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
keep the comment as I still want to do it. Or make it more readable, "use source type or any type instead of URL protocol"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
frontend/gateway/pb/generate.go
Outdated
@@ -1,3 +1,3 @@ | |||
package moby_buildkit_v1_frontend | |||
|
|||
//go:generate protoc -I=. -I=../../../vendor/ --gogo_out=plugins=grpc:. gateway.proto | |||
//go:generate protoc -I=. -I=../../../vendor/ -I=../../../../../../ --gogo_out=plugins=grpc:. gateway.proto |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
follow-up: should do the generation in containers (and validation for CI). Adding more of these includes makes in more dependant on the user environment(eg. symlink in gopath starts to break this)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, and I think we should use https://github.com/stevvooe/protobuild
During conversation at genuinetools/img#18, it appeared that LLB is hard to find for humans. Also, since LLB is used by both solver and client, I think placing it to |
8dc150c
to
62c4818
Compare
LLB has big priority in the readme and impossible to miss. It appears as a first section of how to get started. I don't think the location of the package should be determined like this. In fact, it is bad if people find it before reading the docs, as like I mentioned there are almost no use cases for importing this package unless you want to write a new client in some other programming language. If you don't like |
Lets put things in root level that are either base components/modules of controller or meta categories. Eg. group components that are usable on their own. By quick check for the current state, "identity" seems out of place, everything else seemed ok. LLB is a type definition for two subpackages: |
ok, will revert and just keep document part. Doc part LGTY? |
Yes, new comments as well. |
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
62c4818
to
ecf2e8d
Compare
done |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🐯
Signed-off-by: Akihiro Suda suda.akihiro@lab.ntt.co.jp