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

README documentation on scalapb_proto_library is outdated #744

Closed
steinar opened this issue May 8, 2019 · 1 comment · Fixed by #752
Closed

README documentation on scalapb_proto_library is outdated #744

steinar opened this issue May 8, 2019 · 1 comment · Fixed by #752

Comments

@steinar
Copy link
Contributor

steinar commented May 8, 2019

README documentation on scalapb_proto_library lists a number of arguments which were moved to scala_proto_toolchain in #700.

The documentation suggest one should do the following to include gRPC:

scalapb_proto_library(
    name='ping_scala',
    deps=[':ping'],
    with_grpc = True,
)

Which will result in an error as with_grpc argument is unexpected for scalapb_proto_library. Instead you must overwrite the toolchain in your BUILD file:

load("@io_bazel_rules_scala//scala_proto:scala_proto_toolchain.bzl", "scala_proto_toolchain")

scala_proto_toolchain(
    name = "scala_proto_toolchain_configuration",
    with_grpc = False,
)

toolchain(
    name = "scalapb_toolchain",
    toolchain = ":scala_proto_toolchain_configuration",
    toolchain_type = "@io_bazel_rules_scala//scala_proto:toolchain_type",
    visibility = ["//visibility:public"],
)

AFAIK this change is not documented anywhere.

@johnynek
Copy link
Member

johnynek commented May 8, 2019

yes that's right. A PR to improve the documentation would be welcomed!

gergelyfabian pushed a commit to gergelyfabian/rules_scala that referenced this issue May 31, 2022
* Encapsulate insn/branch status tracking in Instruction
* Move Instruction to the analysis package
* Encapsulate Instruction building in new class InstructionsBuilder
* Separate coverage calculation from filtering
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants