Update docs for proto toolchain #1129
Merged
Conversation
This file contains hidden or 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
simuons
reviewed
Oct 27, 2020
| | with_single_line_to_string | `boolean, optional (default False)` <br> Enables generation of toString() methods that use a single line format. | ||
| | blacklisted_protos | `List of labels, optional` <br> List of protobuf targets to exclude from recursive building. | ||
| | code_generator | `Label, optional (has default)` <br> Which code generator to use. A sensible default is provided. | ||
| | named_generators | `String dict, optional` <br> |
Collaborator
There was a problem hiding this comment.
Maybe add explanation what this dict contains. ie a mapping from protoc plugin name to a class name implementing protocbridge.ProtocCodeGenerator
Collaborator
Author
There was a problem hiding this comment.
This table is from previous doc, I would like to keep changes not related to deps toolchain for another PR
simuons
reviewed
Oct 27, 2020
| | blacklisted_protos | `List of labels, optional` <br> List of protobuf targets to exclude from recursive building. | ||
| | code_generator | `Label, optional (has default)` <br> Which code generator to use. A sensible default is provided. | ||
| | named_generators | `String dict, optional` <br> | ||
| | extra_generator_dependencies | `List of labels, optional` <br> |
Collaborator
There was a problem hiding this comment.
Maybe add explanation that this contains a list of jars where named generators are loaded from.
simuons
approved these changes
Oct 27, 2020
ittaiz
reviewed
Oct 30, 2020
| | extra_generator_dependencies | `List of labels, optional` <br> | ||
| | scalac | `Label, optional (has default)` <br> Target for scalac. A sensible default is provided. | ||
|
|
||
| To configure dependencies, configure a different `scala_proto_deps_toolchain` and declare it in a `BUILD` file: |
Contributor
There was a problem hiding this comment.
Maybe "to configure custom dependencies"? Or does somewhere else clarify that by default you don't need to do anything
Collaborator
Author
There was a problem hiding this comment.
I updated docs with clarification
ittaiz
approved these changes
Oct 30, 2020
blorente
pushed a commit
to twitter-forks/rules_scala
that referenced
this pull request
Nov 26, 2020
* Update docs for proto toolchain * Clarify when to use toolchains
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Docs updates related to a new
scala_proto_deps_toolchaintoolchain