diff options
| author | Florian Klink <flokli@flokli.de> | 2023-09-02T20·24+0300 |
|---|---|---|
| committer | flokli <flokli@flokli.de> | 2023-09-03T10·01+0000 |
| commit | 9bbda4421eaab452fc2bd1b6ce0b862cc3988fd0 (patch) | |
| tree | 290256b02dbc7c5d0bbf6d4894e08ba53937b88a /tvix/store/protos/rpc_pathinfo_grpc.pb.go | |
| parent | 116a137be082547de08bd13382fc31e925ca6217 (diff) | |
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
Diffstat (limited to 'tvix/store/protos/rpc_pathinfo_grpc.pb.go')
| -rw-r--r-- | tvix/store/protos/rpc_pathinfo_grpc.pb.go | 24 |
1 files changed, 8 insertions, 16 deletions
diff --git a/tvix/store/protos/rpc_pathinfo_grpc.pb.go b/tvix/store/protos/rpc_pathinfo_grpc.pb.go index 5a858a3324..bf83a9b7d9 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. |