Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitaly.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Steinhardt <psteinhardt@gitlab.com>2022-07-22 12:31:05 +0300
committerPatrick Steinhardt <psteinhardt@gitlab.com>2022-07-27 16:14:05 +0300
commit5e7c8bbf1629203078b56ea98de87bc34dc037cf (patch)
tree7e5b220dfc3933ced7281bdd338cbb0c06af3afe
parent75d80735ef12c4572a8219cd725084961a8a7893 (diff)
proto: Fill in documentation of FetchIntoObjectPool RPC
Add missing documentation for the FetchIntoObjectPool RPC.
-rw-r--r--proto/go/gitalypb/objectpool.pb.go10
-rw-r--r--proto/go/gitalypb/objectpool_grpc.pb.go10
-rw-r--r--proto/objectpool.proto15
-rw-r--r--ruby/proto/gitaly/objectpool_services_pb.rb5
4 files changed, 26 insertions, 14 deletions
diff --git a/proto/go/gitalypb/objectpool.pb.go b/proto/go/gitalypb/objectpool.pb.go
index 3099253e4..0d1c57a20 100644
--- a/proto/go/gitalypb/objectpool.pb.go
+++ b/proto/go/gitalypb/objectpool.pb.go
@@ -480,17 +480,17 @@ func (*DisconnectGitAlternatesResponse) Descriptor() ([]byte, []int) {
return file_objectpool_proto_rawDescGZIP(), []int{9}
}
-// This comment is left unintentionally blank.
+// FetchIntoObjectPoolRequest is a request for the FetchIntoObjectPool RPC.
type FetchIntoObjectPoolRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
- // This comment is left unintentionally blank.
+ // Origin is the repository to fetch changes from.
Origin *Repository `protobuf:"bytes,1,opt,name=origin,proto3" json:"origin,omitempty"`
- // This comment is left unintentionally blank.
+ // ObjectPool is the repository to fetch changes into.
ObjectPool *ObjectPool `protobuf:"bytes,2,opt,name=object_pool,json=objectPool,proto3" json:"object_pool,omitempty"`
- // This comment is left unintentionally blank.
+ // Repack is not used.
Repack bool `protobuf:"varint,3,opt,name=repack,proto3" json:"repack,omitempty"`
}
@@ -547,7 +547,7 @@ func (x *FetchIntoObjectPoolRequest) GetRepack() bool {
return false
}
-// This comment is left unintentionally blank.
+// FetchIntoObjectPoolResponse is a response for the FetchIntoObjectPool RPC.
type FetchIntoObjectPoolResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
diff --git a/proto/go/gitalypb/objectpool_grpc.pb.go b/proto/go/gitalypb/objectpool_grpc.pb.go
index e4b1038c6..4acbe3aa1 100644
--- a/proto/go/gitalypb/objectpool_grpc.pb.go
+++ b/proto/go/gitalypb/objectpool_grpc.pb.go
@@ -32,7 +32,10 @@ type ObjectPoolServiceClient interface {
ReduplicateRepository(ctx context.Context, in *ReduplicateRepositoryRequest, opts ...grpc.CallOption) (*ReduplicateRepositoryResponse, error)
// This comment is left unintentionally blank.
DisconnectGitAlternates(ctx context.Context, in *DisconnectGitAlternatesRequest, opts ...grpc.CallOption) (*DisconnectGitAlternatesResponse, error)
- // This comment is left unintentionally blank.
+ // FetchIntoObjectPool fetches all references from a pool member into an object pool so that
+ // objects shared between this repository and other pool members can be deduplicated. This RPC
+ // will perform housekeeping tasks after the object pool has been updated to ensure that the pool
+ // is in an optimal state.
FetchIntoObjectPool(ctx context.Context, in *FetchIntoObjectPoolRequest, opts ...grpc.CallOption) (*FetchIntoObjectPoolResponse, error)
// This comment is left unintentionally blank.
GetObjectPool(ctx context.Context, in *GetObjectPoolRequest, opts ...grpc.CallOption) (*GetObjectPoolResponse, error)
@@ -123,7 +126,10 @@ type ObjectPoolServiceServer interface {
ReduplicateRepository(context.Context, *ReduplicateRepositoryRequest) (*ReduplicateRepositoryResponse, error)
// This comment is left unintentionally blank.
DisconnectGitAlternates(context.Context, *DisconnectGitAlternatesRequest) (*DisconnectGitAlternatesResponse, error)
- // This comment is left unintentionally blank.
+ // FetchIntoObjectPool fetches all references from a pool member into an object pool so that
+ // objects shared between this repository and other pool members can be deduplicated. This RPC
+ // will perform housekeeping tasks after the object pool has been updated to ensure that the pool
+ // is in an optimal state.
FetchIntoObjectPool(context.Context, *FetchIntoObjectPoolRequest) (*FetchIntoObjectPoolResponse, error)
// This comment is left unintentionally blank.
GetObjectPool(context.Context, *GetObjectPoolRequest) (*GetObjectPoolResponse, error)
diff --git a/proto/objectpool.proto b/proto/objectpool.proto
index 4d9a36d23..d8223dd25 100644
--- a/proto/objectpool.proto
+++ b/proto/objectpool.proto
@@ -48,7 +48,10 @@ service ObjectPoolService {
};
}
- // This comment is left unintentionally blank.
+ // FetchIntoObjectPool fetches all references from a pool member into an object pool so that
+ // objects shared between this repository and other pool members can be deduplicated. This RPC
+ // will perform housekeeping tasks after the object pool has been updated to ensure that the pool
+ // is in an optimal state.
rpc FetchIntoObjectPool(FetchIntoObjectPoolRequest) returns (FetchIntoObjectPoolResponse) {
option (op_type) = {
op: MUTATOR
@@ -120,17 +123,17 @@ message DisconnectGitAlternatesRequest {
message DisconnectGitAlternatesResponse {
}
-// This comment is left unintentionally blank.
+// FetchIntoObjectPoolRequest is a request for the FetchIntoObjectPool RPC.
message FetchIntoObjectPoolRequest {
- // This comment is left unintentionally blank.
+ // Origin is the repository to fetch changes from.
Repository origin = 1 [(additional_repository)=true];
- // This comment is left unintentionally blank.
+ // ObjectPool is the repository to fetch changes into.
ObjectPool object_pool = 2 [(target_repository)=true];
- // This comment is left unintentionally blank.
+ // Repack is not used.
bool repack = 3;
}
-// This comment is left unintentionally blank.
+// FetchIntoObjectPoolResponse is a response for the FetchIntoObjectPool RPC.
message FetchIntoObjectPoolResponse {
}
diff --git a/ruby/proto/gitaly/objectpool_services_pb.rb b/ruby/proto/gitaly/objectpool_services_pb.rb
index d0529fa3d..fe12b6ab2 100644
--- a/ruby/proto/gitaly/objectpool_services_pb.rb
+++ b/ruby/proto/gitaly/objectpool_services_pb.rb
@@ -28,7 +28,10 @@ module Gitaly
rpc :ReduplicateRepository, ::Gitaly::ReduplicateRepositoryRequest, ::Gitaly::ReduplicateRepositoryResponse
# This comment is left unintentionally blank.
rpc :DisconnectGitAlternates, ::Gitaly::DisconnectGitAlternatesRequest, ::Gitaly::DisconnectGitAlternatesResponse
- # This comment is left unintentionally blank.
+ # FetchIntoObjectPool fetches all references from a pool member into an object pool so that
+ # objects shared between this repository and other pool members can be deduplicated. This RPC
+ # will perform housekeeping tasks after the object pool has been updated to ensure that the pool
+ # is in an optimal state.
rpc :FetchIntoObjectPool, ::Gitaly::FetchIntoObjectPoolRequest, ::Gitaly::FetchIntoObjectPoolResponse
# This comment is left unintentionally blank.
rpc :GetObjectPool, ::Gitaly::GetObjectPoolRequest, ::Gitaly::GetObjectPoolResponse