Skip to content

Commit 53be8cc

Browse files
committed
Markdown table fixes.
1 parent 3dd2b44 commit 53be8cc

File tree

4 files changed

+7
-19
lines changed

4 files changed

+7
-19
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ that the file
215215
in the package `google.protobuf`.
216216

217217
2. *Can the `cc_proto_library` rule "see" the generated protobuf
218-
files* (in this case `descriptor.pb.{h,cc}`. Just because the file
218+
files*? (in this case `descriptor.pb.{h,cc}`. Just because the file
219219
was imported does not imply that protoc will generate outputs for
220220
it, so somewhere in the `cc_library` rule dependency chain these
221221
files must be present. This could be via another
@@ -224,8 +224,8 @@ in the package `google.protobuf`.
224224
specify that in the `proto_deps` attribute to the calling
225225
`cc_proto_library` rule. Otherwise, pass a label that includes the
226226
(pregenerated) protobuf files to the `deps` attribute, just as you
227-
would any typical `cc_library` rule.Hopefully that made sense.
228-
It's tricky.
227+
would any typical `cc_library` rule. Hopefully that made sense.
228+
It's a bit tricky.
229229

230230
# Contributing
231231

bzl/README.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,18 @@ lists attributes and behavior that is shared across all languages.
55
# `*_proto_compile` attributes
66

77
| Name | Type | Description | Default |
8-
8+
| ---- | ---- | ----------- | ------- |
99
| `name` | `string` | The name of the rule (required) | `""` |
10-
1110
| `protos` | `label_list` of file type `.proto` | The set of protobuf source files to compile. Must not be empty. | `[]` |
12-
1311
| `proto_deps` | `label_list` having provider `proto` | A list of `*_proto_library` that the calling rule is dependent upon. | `[]` |
14-
1512
| `protoc` | executable `label` | Used to override the default protoc binary tool. | `//external:protoc` |
16-
1713
| `gen_{LANG}` | `boolean` | Enable/disable protobuf output on a language-specific basis. | Usually `True` |
18-
1914
| `gen_{LANG}_grpc` | `boolean` | Enable/disable gRPC output on a language-specific basis. | `False` |
20-
2115
| `gen_{LANG}_protobuf_binary` | executable `label` | Use to override the plugin executable on a language-specific basis. This attribute will not exist if this the language does not require a plugin for it. | *Implementation-specific* |
22-
2316
| `gen_{LANG}_protobuf_options` | `string_list` | Additional options to be bundled into to the `--{LANG}_out` argument. | `[]` |
24-
2517
| `gen_{LANG}_grpc_binary` | executable `label` | Use to override the grpc plugin executable on a language-specific basis. This attribute will not exist if this the language does support or require a plugin for this. | *Implementation-specific* |
26-
2718
| `gen_{LANG}_grpc_options` | `string_list` | Additional options to be bundled into to the `--grpc-{LANG}_out` argument. | `[]` |
28-
2919
| `outs` | `output_list` | Permits language implementation to specify additional implicit output targets. Currently only used by the java implementations which expose `%{name}.srcjar` as an implicit handle to the generated sourcefiles.` | `{}` |
30-
3120
| `output_to_workspace` | `boolean` | Under normal operation, generated code is placed in the bazel sandbox and does not need to be checked in into version control. However, your requirements may be such that is necessary to check these generated files in. Setting this flag to `True` will emit generated `*.pb.*` files into in your workspace alongside the `*.proto` source files. Please make sure you're sure you want to do this as it has the potential for unwanted overwrite of source files. | `False` |
3221

3322

@@ -38,7 +27,7 @@ The attributes `protoc`, `protos`, `proto_deps`, `imports`,
3827
`*_proto_library` rules, as described above.
3928

4029
| Name | Type | Description | Default |
41-
30+
| ---- | ---- | ----------- | ------- |
4231
| `name` | `string` | The name of the library rule (required). The implicit output target `%{name}.pb` refers to the corresponding proto_compile rule. | `""` |
4332
| `proto_args` | `dict` | A dictionary of arguments to be passed to the `*_proto_compile` implementation. | `{}` |
4433
| `srcs` | `label_list` of file type specific to library rule | Additional source files passed to the implementing library rule (for example, `cc_library` | `[]` |

bzl/go/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,6 @@ the protobuf library rule name, in which case part III is not needed.
120120
The go rules include all common attributes in addition to:
121121

122122
| Name | Type | Description | Default |
123-
123+
| ---- | ---- | ----------- | ------- |
124124
| `go_import_map` | `string_dict` | A set of mappings from protobuf imports to go imports. | `{}` |
125-
126125
| `go_prefix` | `label` of provider go_prefix (from rules_go). | The go prefix that should be used be code generated by this rule. | `//:go_prefix` |

bzl/grpc_gateway/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ grpc_gateway_binary(
8585
The grpc_gateway rules include all common attributes in addition to go rule attributes in addition to:
8686

8787
| Name | Type | Description | Default |
88-
88+
| ---- | ---- | ----------- | ------- |
8989
| `log_level` | `int` | Logging threshold level. | `0` |
9090
| `log_dir` | `string` | Log directory pathname. | `""` |
9191
| `log_backtrace_at` | `int` | See grpc_gateway docs. | `0` |

0 commit comments

Comments
 (0)