From e7d88223a73d51e2493c81cabbc983672b2ce8c9 Mon Sep 17 00:00:00 2001 From: infovivek2020 Date: Fri, 12 Jul 2024 21:29:09 +0530 Subject: [PATCH] protoc-gen-go-grpc: add period to end of generated comment (#7392) --- .../grpclb/grpc_lb_v1/load_balancer_grpc.pb.go | 2 +- channelz/grpc_channelz_v1/channelz_grpc.pb.go | 2 +- cmd/protoc-gen-go-grpc/grpc.go | 2 +- .../internal/proto/grpc_gcp/handshaker_grpc.pb.go | 2 +- examples/features/proto/echo/echo_grpc.pb.go | 2 +- .../helloworld/helloworld/helloworld_grpc.pb.go | 2 +- .../route_guide/routeguide/route_guide_grpc.pb.go | 2 +- health/grpc_health_v1/health_grpc.pb.go | 2 +- internal/proto/grpc_lookup_v1/rls_grpc.pb.go | 2 +- interop/grpc_testing/benchmark_service_grpc.pb.go | 2 +- .../report_qps_scenario_service_grpc.pb.go | 2 +- interop/grpc_testing/test_grpc.pb.go | 14 +++++++------- interop/grpc_testing/worker_service_grpc.pb.go | 2 +- interop/stress/grpc_testing/metrics_grpc.pb.go | 2 +- profiling/proto/service_grpc.pb.go | 2 +- .../grpc_reflection_v1/reflection_grpc.pb.go | 2 +- .../grpc_reflection_v1alpha/reflection_grpc.pb.go | 2 +- reflection/grpc_testing/test_grpc.pb.go | 2 +- 18 files changed, 24 insertions(+), 24 deletions(-) diff --git a/balancer/grpclb/grpc_lb_v1/load_balancer_grpc.pb.go b/balancer/grpclb/grpc_lb_v1/load_balancer_grpc.pb.go index 90170795cc88..69cc6c005f82 100644 --- a/balancer/grpclb/grpc_lb_v1/load_balancer_grpc.pb.go +++ b/balancer/grpclb/grpc_lb_v1/load_balancer_grpc.pb.go @@ -72,7 +72,7 @@ type LoadBalancer_BalanceLoadClient = grpc.BidiStreamingClient[LoadBalanceReques // LoadBalancerServer is the server API for LoadBalancer service. // All implementations should embed UnimplementedLoadBalancerServer -// for forward compatibility +// for forward compatibility. type LoadBalancerServer interface { // Bidirectional rpc to get a list of servers. BalanceLoad(grpc.BidiStreamingServer[LoadBalanceRequest, LoadBalanceResponse]) error diff --git a/channelz/grpc_channelz_v1/channelz_grpc.pb.go b/channelz/grpc_channelz_v1/channelz_grpc.pb.go index d0b6639b9355..3f5d8ea2c3ce 100644 --- a/channelz/grpc_channelz_v1/channelz_grpc.pb.go +++ b/channelz/grpc_channelz_v1/channelz_grpc.pb.go @@ -153,7 +153,7 @@ func (c *channelzClient) GetSocket(ctx context.Context, in *GetSocketRequest, op // ChannelzServer is the server API for Channelz service. // All implementations should embed UnimplementedChannelzServer -// for forward compatibility +// for forward compatibility. // // Channelz is a service exposed by gRPC servers that provides detailed debug // information. diff --git a/cmd/protoc-gen-go-grpc/grpc.go b/cmd/protoc-gen-go-grpc/grpc.go index 9088bc2a17c9..08529b1966d5 100644 --- a/cmd/protoc-gen-go-grpc/grpc.go +++ b/cmd/protoc-gen-go-grpc/grpc.go @@ -264,7 +264,7 @@ func genService(gen *protogen.Plugin, file *protogen.File, g *protogen.Generated serverType := service.GoName + "Server" g.P("// ", serverType, " is the server API for ", service.GoName, " service.") g.P("// All implementations ", mustOrShould, " embed Unimplemented", serverType) - g.P("// for forward compatibility") + g.P("// for forward compatibility.") // Copy comments from proto file. genServiceComments(g, service) diff --git a/credentials/alts/internal/proto/grpc_gcp/handshaker_grpc.pb.go b/credentials/alts/internal/proto/grpc_gcp/handshaker_grpc.pb.go index add078c98c08..e116cfdd70d6 100644 --- a/credentials/alts/internal/proto/grpc_gcp/handshaker_grpc.pb.go +++ b/credentials/alts/internal/proto/grpc_gcp/handshaker_grpc.pb.go @@ -75,7 +75,7 @@ type HandshakerService_DoHandshakeClient = grpc.BidiStreamingClient[HandshakerRe // HandshakerServiceServer is the server API for HandshakerService service. // All implementations must embed UnimplementedHandshakerServiceServer -// for forward compatibility +// for forward compatibility. type HandshakerServiceServer interface { // Handshaker service accepts a stream of handshaker request, returning a // stream of handshaker response. Client is expected to send exactly one diff --git a/examples/features/proto/echo/echo_grpc.pb.go b/examples/features/proto/echo/echo_grpc.pb.go index 8a78ce1b63d1..9fb9f9e660e2 100644 --- a/examples/features/proto/echo/echo_grpc.pb.go +++ b/examples/features/proto/echo/echo_grpc.pb.go @@ -123,7 +123,7 @@ type Echo_BidirectionalStreamingEchoClient = grpc.BidiStreamingClient[EchoReques // EchoServer is the server API for Echo service. // All implementations must embed UnimplementedEchoServer -// for forward compatibility +// for forward compatibility. // // Echo is the echo service. type EchoServer interface { diff --git a/examples/helloworld/helloworld/helloworld_grpc.pb.go b/examples/helloworld/helloworld/helloworld_grpc.pb.go index 59a198843203..24eeab8566ca 100644 --- a/examples/helloworld/helloworld/helloworld_grpc.pb.go +++ b/examples/helloworld/helloworld/helloworld_grpc.pb.go @@ -66,7 +66,7 @@ func (c *greeterClient) SayHello(ctx context.Context, in *HelloRequest, opts ... // GreeterServer is the server API for Greeter service. // All implementations must embed UnimplementedGreeterServer -// for forward compatibility +// for forward compatibility. // // The greeting service definition. type GreeterServer interface { diff --git a/examples/route_guide/routeguide/route_guide_grpc.pb.go b/examples/route_guide/routeguide/route_guide_grpc.pb.go index d7929375d427..490f6e462d1c 100644 --- a/examples/route_guide/routeguide/route_guide_grpc.pb.go +++ b/examples/route_guide/routeguide/route_guide_grpc.pb.go @@ -136,7 +136,7 @@ type RouteGuide_RouteChatClient = grpc.BidiStreamingClient[RouteNote, RouteNote] // RouteGuideServer is the server API for RouteGuide service. // All implementations must embed UnimplementedRouteGuideServer -// for forward compatibility +// for forward compatibility. // // Interface exported by the server. type RouteGuideServer interface { diff --git a/health/grpc_health_v1/health_grpc.pb.go b/health/grpc_health_v1/health_grpc.pb.go index 24f475c90b82..91b4c7c1b90a 100644 --- a/health/grpc_health_v1/health_grpc.pb.go +++ b/health/grpc_health_v1/health_grpc.pb.go @@ -115,7 +115,7 @@ type Health_WatchClient = grpc.ServerStreamingClient[HealthCheckResponse] // HealthServer is the server API for Health service. // All implementations should embed UnimplementedHealthServer -// for forward compatibility +// for forward compatibility. // // Health is gRPC's mechanism for checking whether a server is able to handle // RPCs. Its semantics are documented in diff --git a/internal/proto/grpc_lookup_v1/rls_grpc.pb.go b/internal/proto/grpc_lookup_v1/rls_grpc.pb.go index 4fb4301e93dd..3be9b94b7d31 100644 --- a/internal/proto/grpc_lookup_v1/rls_grpc.pb.go +++ b/internal/proto/grpc_lookup_v1/rls_grpc.pb.go @@ -64,7 +64,7 @@ func (c *routeLookupServiceClient) RouteLookup(ctx context.Context, in *RouteLoo // RouteLookupServiceServer is the server API for RouteLookupService service. // All implementations must embed UnimplementedRouteLookupServiceServer -// for forward compatibility +// for forward compatibility. type RouteLookupServiceServer interface { // Lookup returns a target for a single key. RouteLookup(context.Context, *RouteLookupRequest) (*RouteLookupResponse, error) diff --git a/interop/grpc_testing/benchmark_service_grpc.pb.go b/interop/grpc_testing/benchmark_service_grpc.pb.go index 3d3f04caaedd..2e7a2d5450f4 100644 --- a/interop/grpc_testing/benchmark_service_grpc.pb.go +++ b/interop/grpc_testing/benchmark_service_grpc.pb.go @@ -143,7 +143,7 @@ type BenchmarkService_StreamingBothWaysClient = grpc.BidiStreamingClient[SimpleR // BenchmarkServiceServer is the server API for BenchmarkService service. // All implementations must embed UnimplementedBenchmarkServiceServer -// for forward compatibility +// for forward compatibility. type BenchmarkServiceServer interface { // One request followed by one response. // The server returns the client payload as-is. diff --git a/interop/grpc_testing/report_qps_scenario_service_grpc.pb.go b/interop/grpc_testing/report_qps_scenario_service_grpc.pb.go index de57548c6abb..aa2dfd2f04e9 100644 --- a/interop/grpc_testing/report_qps_scenario_service_grpc.pb.go +++ b/interop/grpc_testing/report_qps_scenario_service_grpc.pb.go @@ -67,7 +67,7 @@ func (c *reportQpsScenarioServiceClient) ReportScenario(ctx context.Context, in // ReportQpsScenarioServiceServer is the server API for ReportQpsScenarioService service. // All implementations must embed UnimplementedReportQpsScenarioServiceServer -// for forward compatibility +// for forward compatibility. type ReportQpsScenarioServiceServer interface { // Report results of a QPS test benchmark scenario. ReportScenario(context.Context, *ScenarioResult) (*Void, error) diff --git a/interop/grpc_testing/test_grpc.pb.go b/interop/grpc_testing/test_grpc.pb.go index 4f00e83835e0..4f0ae5b97598 100644 --- a/interop/grpc_testing/test_grpc.pb.go +++ b/interop/grpc_testing/test_grpc.pb.go @@ -189,7 +189,7 @@ func (c *testServiceClient) UnimplementedCall(ctx context.Context, in *Empty, op // TestServiceServer is the server API for TestService service. // All implementations must embed UnimplementedTestServiceServer -// for forward compatibility +// for forward compatibility. // // A simple service to test the various types of RPCs and experiment with // performance with various types of payload. @@ -454,7 +454,7 @@ func (c *unimplementedServiceClient) UnimplementedCall(ctx context.Context, in * // UnimplementedServiceServer is the server API for UnimplementedService service. // All implementations must embed UnimplementedUnimplementedServiceServer -// for forward compatibility +// for forward compatibility. // // A simple service NOT implemented at servers so clients can test for // that case. @@ -563,7 +563,7 @@ func (c *reconnectServiceClient) Stop(ctx context.Context, in *Empty, opts ...gr // ReconnectServiceServer is the server API for ReconnectService service. // All implementations must embed UnimplementedReconnectServiceServer -// for forward compatibility +// for forward compatibility. // // A service used to control reconnect server. type ReconnectServiceServer interface { @@ -698,7 +698,7 @@ func (c *loadBalancerStatsServiceClient) GetClientAccumulatedStats(ctx context.C // LoadBalancerStatsServiceServer is the server API for LoadBalancerStatsService service. // All implementations must embed UnimplementedLoadBalancerStatsServiceServer -// for forward compatibility +// for forward compatibility. // // A service used to obtain stats for verifying LB behavior. type LoadBalancerStatsServiceServer interface { @@ -850,7 +850,7 @@ func (c *hookServiceClient) ClearReturnStatus(ctx context.Context, in *Empty, op // HookServiceServer is the server API for HookService service. // All implementations must embed UnimplementedHookServiceServer -// for forward compatibility +// for forward compatibility. // // Hook service. Used to keep Kubernetes from shutting the pod down. type HookServiceServer interface { @@ -1025,7 +1025,7 @@ func (c *xdsUpdateHealthServiceClient) SendHookRequest(ctx context.Context, in * // XdsUpdateHealthServiceServer is the server API for XdsUpdateHealthService service. // All implementations must embed UnimplementedXdsUpdateHealthServiceServer -// for forward compatibility +// for forward compatibility. // // A service to remotely control health status of an xDS test server. type XdsUpdateHealthServiceServer interface { @@ -1174,7 +1174,7 @@ func (c *xdsUpdateClientConfigureServiceClient) Configure(ctx context.Context, i // XdsUpdateClientConfigureServiceServer is the server API for XdsUpdateClientConfigureService service. // All implementations must embed UnimplementedXdsUpdateClientConfigureServiceServer -// for forward compatibility +// for forward compatibility. // // A service to dynamically update the configuration of an xDS test client. type XdsUpdateClientConfigureServiceServer interface { diff --git a/interop/grpc_testing/worker_service_grpc.pb.go b/interop/grpc_testing/worker_service_grpc.pb.go index 153e6419947b..de04fd006b17 100644 --- a/interop/grpc_testing/worker_service_grpc.pb.go +++ b/interop/grpc_testing/worker_service_grpc.pb.go @@ -122,7 +122,7 @@ func (c *workerServiceClient) QuitWorker(ctx context.Context, in *Void, opts ... // WorkerServiceServer is the server API for WorkerService service. // All implementations must embed UnimplementedWorkerServiceServer -// for forward compatibility +// for forward compatibility. type WorkerServiceServer interface { // Start server with specified workload. // First request sent specifies the ServerConfig followed by ServerStatus diff --git a/interop/stress/grpc_testing/metrics_grpc.pb.go b/interop/stress/grpc_testing/metrics_grpc.pb.go index b84f1be2ad0c..7d18e153bd63 100644 --- a/interop/stress/grpc_testing/metrics_grpc.pb.go +++ b/interop/stress/grpc_testing/metrics_grpc.pb.go @@ -94,7 +94,7 @@ func (c *metricsServiceClient) GetGauge(ctx context.Context, in *GaugeRequest, o // MetricsServiceServer is the server API for MetricsService service. // All implementations must embed UnimplementedMetricsServiceServer -// for forward compatibility +// for forward compatibility. type MetricsServiceServer interface { // Returns the values of all the gauges that are currently being maintained by // the service diff --git a/profiling/proto/service_grpc.pb.go b/profiling/proto/service_grpc.pb.go index 8b663da70ae9..eba4069b7bf8 100644 --- a/profiling/proto/service_grpc.pb.go +++ b/profiling/proto/service_grpc.pb.go @@ -81,7 +81,7 @@ func (c *profilingClient) GetStreamStats(ctx context.Context, in *GetStreamStats // ProfilingServer is the server API for Profiling service. // All implementations should embed UnimplementedProfilingServer -// for forward compatibility +// for forward compatibility. // // The Profiling service exposes functions to remotely manage the gRPC // profiling behaviour in a program. diff --git a/reflection/grpc_reflection_v1/reflection_grpc.pb.go b/reflection/grpc_reflection_v1/reflection_grpc.pb.go index f8a755e3b86b..f633e64a1382 100644 --- a/reflection/grpc_reflection_v1/reflection_grpc.pb.go +++ b/reflection/grpc_reflection_v1/reflection_grpc.pb.go @@ -75,7 +75,7 @@ type ServerReflection_ServerReflectionInfoClient = grpc.BidiStreamingClient[Serv // ServerReflectionServer is the server API for ServerReflection service. // All implementations should embed UnimplementedServerReflectionServer -// for forward compatibility +// for forward compatibility. type ServerReflectionServer interface { // The reflection service is structured as a bidirectional stream, ensuring // all related requests go to a single server. diff --git a/reflection/grpc_reflection_v1alpha/reflection_grpc.pb.go b/reflection/grpc_reflection_v1alpha/reflection_grpc.pb.go index a6fb174378a1..7d9ad63066aa 100644 --- a/reflection/grpc_reflection_v1alpha/reflection_grpc.pb.go +++ b/reflection/grpc_reflection_v1alpha/reflection_grpc.pb.go @@ -72,7 +72,7 @@ type ServerReflection_ServerReflectionInfoClient = grpc.BidiStreamingClient[Serv // ServerReflectionServer is the server API for ServerReflection service. // All implementations should embed UnimplementedServerReflectionServer -// for forward compatibility +// for forward compatibility. type ServerReflectionServer interface { // The reflection service is structured as a bidirectional stream, ensuring // all related requests go to a single server. diff --git a/reflection/grpc_testing/test_grpc.pb.go b/reflection/grpc_testing/test_grpc.pb.go index 6c81f6b84e92..6d8e2cd0679b 100644 --- a/reflection/grpc_testing/test_grpc.pb.go +++ b/reflection/grpc_testing/test_grpc.pb.go @@ -78,7 +78,7 @@ type SearchService_StreamingSearchClient = grpc.BidiStreamingClient[SearchReques // SearchServiceServer is the server API for SearchService service. // All implementations must embed UnimplementedSearchServiceServer -// for forward compatibility +// for forward compatibility. type SearchServiceServer interface { Search(context.Context, *SearchRequest) (*SearchResponse, error) StreamingSearch(grpc.BidiStreamingServer[SearchRequest, SearchResponse]) error