docs(tvix/store): update rpc_pathinfo.proto comments r/6547

Don't repeat the name of the method in the description, don't repeat
things already described in request message comments.

Change-Id: I180e4792577419050947eea8fea7043861aba463
Reviewed-on: https://cl.tvl.fyi/c/depot/+/9213
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI

3 files changed, 14 insertions, 28 deletions

diff --git a/tvix/store/protos/rpc_pathinfo.pb.go b/tvix/store/protos/rpc_pathinfo.pb.go
index 53eb31f81830..bc4da2a127f9 100644
--- a/tvix/store/protos/rpc_pathinfo.pb.go
+++ b/tvix/store/protos/rpc_pathinfo.pb.go
@@ -23,8 +23,7 @@ const (
 	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
 )
 
-// GetPathInfoRequest describes the lookup parameters that can be used to
-// lookup a PathInfo objects.
+// The parameters that can be used to lookup a (single) PathInfo object.
 // Currently, only a lookup by output hash is supported.
 type GetPathInfoRequest struct {
 	state         protoimpl.MessageState
diff --git a/tvix/store/protos/rpc_pathinfo.proto b/tvix/store/protos/rpc_pathinfo.proto
index 991abf6efa99..fecf682d168d 100644
--- a/tvix/store/protos/rpc_pathinfo.proto
+++ b/tvix/store/protos/rpc_pathinfo.proto
@@ -9,16 +9,12 @@ import "tvix/store/protos/pathinfo.proto";
 option go_package = "code.tvl.fyi/tvix/store/protos;storev1";
 
 service PathInfoService {
-    // Return a PathInfo message, identified by the decoded nixbase32 part
-    // of a Nix output path.
-    //
-    // To substitute /nix/store/xm35nga2g20mz5sm5l6n8v3bdm86yj83-
-    // cowsay-3.04 the bytes in the request would be
-    // nixbase32dec("xm35nga2g20mz5sm5l6n8v3bdm86yj83").
+    // Return a PathInfo message matching the criteria specified in the
+    // GetPathInfoRequest message.
     rpc Get(GetPathInfoRequest) returns (PathInfo);
 
-    // Put uploads a PathInfo object to the remote end. It MUST not return
-    // until the PathInfo object has been written on the the remote end.
+    // Upload a PathInfo object to the remote end. It MUST not return until the
+    // PathInfo object has been written on the the remote end.
     //
     // The remote end MAY check if a potential DirectoryNode has already been
     // uploaded.
@@ -47,8 +43,7 @@ service PathInfoService {
     rpc CalculateNAR(Node) returns (CalculateNARResponse);
 }
 
-// GetPathInfoRequest describes the lookup parameters that can be used to
-// lookup a PathInfo objects.
+// The parameters that can be used to lookup a (single) PathInfo object.
 // Currently, only a lookup by output hash is supported.
 message GetPathInfoRequest {
     oneof by_what {
diff --git a/tvix/store/protos/rpc_pathinfo_grpc.pb.go b/tvix/store/protos/rpc_pathinfo_grpc.pb.go
index 5a858a3324c6..bf83a9b7d98b 100644
--- a/tvix/store/protos/rpc_pathinfo_grpc.pb.go
+++ b/tvix/store/protos/rpc_pathinfo_grpc.pb.go
@@ -31,15 +31,11 @@ const (
 //
 // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
 type PathInfoServiceClient interface {
-	// Return a PathInfo message, identified by the decoded nixbase32 part
-	// of a Nix output path.
-	//
-	// To substitute /nix/store/xm35nga2g20mz5sm5l6n8v3bdm86yj83-
-	// cowsay-3.04 the bytes in the request would be
-	// nixbase32dec("xm35nga2g20mz5sm5l6n8v3bdm86yj83").
+	// Return a PathInfo message matching the criteria specified in the
+	// GetPathInfoRequest message.
 	Get(ctx context.Context, in *GetPathInfoRequest, opts ...grpc.CallOption) (*PathInfo, error)
-	// Put uploads a PathInfo object to the remote end. It MUST not return
-	// until the PathInfo object has been written on the the remote end.
+	// Upload a PathInfo object to the remote end. It MUST not return until the
+	// PathInfo object has been written on the the remote end.
 	//
 	// The remote end MAY check if a potential DirectoryNode has already been
 	// uploaded.
@@ -105,15 +101,11 @@ func (c *pathInfoServiceClient) CalculateNAR(ctx context.Context, in *Node, opts
 // All implementations must embed UnimplementedPathInfoServiceServer
 // for forward compatibility
 type PathInfoServiceServer interface {
-	// Return a PathInfo message, identified by the decoded nixbase32 part
-	// of a Nix output path.
-	//
-	// To substitute /nix/store/xm35nga2g20mz5sm5l6n8v3bdm86yj83-
-	// cowsay-3.04 the bytes in the request would be
-	// nixbase32dec("xm35nga2g20mz5sm5l6n8v3bdm86yj83").
+	// Return a PathInfo message matching the criteria specified in the
+	// GetPathInfoRequest message.
 	Get(context.Context, *GetPathInfoRequest) (*PathInfo, error)
-	// Put uploads a PathInfo object to the remote end. It MUST not return
-	// until the PathInfo object has been written on the the remote end.
+	// Upload a PathInfo object to the remote end. It MUST not return until the
+	// PathInfo object has been written on the the remote end.
 	//
 	// The remote end MAY check if a potential DirectoryNode has already been
 	// uploaded.