Skip to content

Commit d000a15

Browse files
authored
faq.md: Include note that renaming the package name breaks gRPC
The gRPC protocol includes the fully-qualified protobuf names for the request/response types, so renaming the package breaks this. Add a note about this.
1 parent 4c7b73c commit d000a15

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

content/reference/go/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,9 @@ Common ways that namespace conflicts occur:
152152
deliberately chosen to be universally unique (for example, prefixed with the
153153
name of a company).
154154

155-
* Warning: Retroactively changing the package name on a `.proto` file can
156-
potentially cause the use of extension fields or messages stored in
157-
`google.protobuf.Any` to stop working properly.
155+
* Warning: Retroactively changing the package name on a `.proto` file is
156+
not backwards compatible for types used as extension fields, stored in
157+
`google.protobuf.Any`, or used as gRPC requests or responses.
158158

159159
Starting with v1.26.0 of the `google.golang.org/protobuf` module, a hard error
160160
will be reported when a Go program starts up that has multiple conflicting

0 commit comments

Comments
 (0)