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.proto | |
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.proto')
-rw-r--r-- | tvix/store/protos/rpc_pathinfo.proto | 15 |
1 files changed, 5 insertions, 10 deletions
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 { |