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

Fix README typo (---go-grpc_out -> --go-grpc_opt) #4538

Closed
wants to merge 1 commit into from

Conversation

shomron
Copy link

@shomron shomron commented Jun 12, 2021

Fixes typo in README for protoc-gen-go-grpc regarding how to disable the new require_unimplemented_servers compatibility behavior.

Signed-off-by: Oren Shomron shomron@gmail.com

Signed-off-by: Oren Shomron <shomron@gmail.com>
Copy link
Member

@dfawley dfawley left a comment

Choose a reason for hiding this comment

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

I believe what we have is correct. If you want to use the opt flag, you'd still need to use out to specify the output directory:

protoc --go-grpc_opt=require_unimplemented_servers=false[,other options...] --go-grpc_out=.

@dfawley
Copy link
Member

dfawley commented Jun 14, 2021

(Let me know if I'm mistaken and you're seeing errors with the suggested usage as-is.)

@dfawley dfawley closed this Jun 14, 2021
@shomron
Copy link
Author

shomron commented Jun 14, 2021

@dfawley thanks for looking at this! I see, this seems to be a matter of:

protoc --go-grpc_out=paths=source_relative,require_unimplemented_servers=false:. example.proto

vs.

protoc --go-grpc_out=. --go-grpc_opt=paths=source_relative,require_unimplemented_servers=false example.proto

I was following the example in the gRPC / Go quickstart which has the options broken apart, and trying to combine that with the syntax from this README didn't work. I have to say I'm having trouble tracking down the documentation for these various syntax options - do those exist anywhere?

@dfawley
Copy link
Member

dfawley commented Jun 14, 2021

I have to say I'm having trouble tracking down the documentation for these various syntax options - do those exist anywhere?

I have to admit I had a hard time with this as well, and only, in fact, learned the difference between opt and out a week or two ago. I think the documentation of protoc and its plugins is lacking (or hiding somewhere).

@shomron shomron deleted the readme-typo branch June 14, 2021 17:26
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants