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
path: root/proto
diff options
context:
space:
mode:
authorPatrick Steinhardt <psteinhardt@gitlab.com>2023-09-13 15:38:40 +0300
committerPatrick Steinhardt <psteinhardt@gitlab.com>2023-09-13 17:01:22 +0300
commit356250bceb43e0c821f6b37f874d4393b1dccb31 (patch)
tree581c01db8ffa3cb078b1b40c8a1a0da27f09307d /proto
parent38ef059bafde3c7e501114d79d1d86d2de845a10 (diff)
proto: Add documentation for RawBlame RPC
The RawBlame RPC is missing documentation. Add it.
Diffstat (limited to 'proto')
-rw-r--r--proto/commit.proto20
-rw-r--r--proto/go/gitalypb/commit.pb.go17
-rw-r--r--proto/go/gitalypb/commit_grpc.pb.go6
3 files changed, 24 insertions, 19 deletions
diff --git a/proto/commit.proto b/proto/commit.proto
index 919ede288..af101ec3f 100644
--- a/proto/commit.proto
+++ b/proto/commit.proto
@@ -108,7 +108,8 @@ service CommitService {
};
}
- // This comment is left unintentionally blank.
+ // RawBlame blames lines in a blob to when they have last been changed. Returns the raw output of the git-blame(1)
+ // command.
rpc RawBlame(RawBlameRequest) returns (stream RawBlameResponse) {
option (op_type) = {
op: ACCESSOR
@@ -682,22 +683,23 @@ message CommitLanguagesResponse {
repeated Language languages = 1;
}
-// This comment is left unintentionally blank.
+// RawBlameRequest is a request for the RawBlame RPC.
message RawBlameRequest {
- // This comment is left unintentionally blank.
+ // Repository is the repositroy where to perform the blame.
Repository repository = 1 [(target_repository)=true];
- // This comment is left unintentionally blank.
+ // Revision is the committish at which to start the blame.
bytes revision = 2;
- // This comment is left unintentionally blank.
+ // Path is the path of the blob that should be blamed.
bytes path = 3;
- // Comma-separated range of line numbers to perform the blame on: "1,1000".
- // Optional - if no range is provided, the whole file will be blamed.
+ // Range is the comma-separated range of line numbers to perform the blame on, e.g. "1,1000". Optional - if no range
+ // is provided, the whole file will be blamed.
bytes range = 4;
}
-// This comment is left unintentionally blank.
+// RawBlameResponse is a response for the RawBlame RPC. The response will be chunked into multiple message if the
+// returned data exceeds gRPC message limits.
message RawBlameResponse {
- // This comment is left unintentionally blank.
+ // Data is the raw data as generated by git-blame(1).
bytes data = 1;
}
diff --git a/proto/go/gitalypb/commit.pb.go b/proto/go/gitalypb/commit.pb.go
index 6f6a9b8c1..485c82409 100644
--- a/proto/go/gitalypb/commit.pb.go
+++ b/proto/go/gitalypb/commit.pb.go
@@ -2719,20 +2719,20 @@ func (x *CommitLanguagesResponse) GetLanguages() []*CommitLanguagesResponse_Lang
return nil
}
-// This comment is left unintentionally blank.
+// RawBlameRequest is a request for the RawBlame RPC.
type RawBlameRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
- // This comment is left unintentionally blank.
+ // Repository is the repositroy where to perform the blame.
Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
- // This comment is left unintentionally blank.
+ // Revision is the committish at which to start the blame.
Revision []byte `protobuf:"bytes,2,opt,name=revision,proto3" json:"revision,omitempty"`
- // This comment is left unintentionally blank.
+ // Path is the path of the blob that should be blamed.
Path []byte `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
- // Comma-separated range of line numbers to perform the blame on: "1,1000".
- // Optional - if no range is provided, the whole file will be blamed.
+ // Range is the comma-separated range of line numbers to perform the blame on, e.g. "1,1000". Optional - if no range
+ // is provided, the whole file will be blamed.
Range []byte `protobuf:"bytes,4,opt,name=range,proto3" json:"range,omitempty"`
}
@@ -2796,13 +2796,14 @@ func (x *RawBlameRequest) GetRange() []byte {
return nil
}
-// This comment is left unintentionally blank.
+// RawBlameResponse is a response for the RawBlame RPC. The response will be chunked into multiple message if the
+// returned data exceeds gRPC message limits.
type RawBlameResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
- // This comment is left unintentionally blank.
+ // Data is the raw data as generated by git-blame(1).
Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
}
diff --git a/proto/go/gitalypb/commit_grpc.pb.go b/proto/go/gitalypb/commit_grpc.pb.go
index e3aeeaa06..d476f2d91 100644
--- a/proto/go/gitalypb/commit_grpc.pb.go
+++ b/proto/go/gitalypb/commit_grpc.pb.go
@@ -52,7 +52,8 @@ type CommitServiceClient interface {
// CommitLanguages detects the source code languages of the whole tree for a
// given commit. Returns an error in case no languages could be detected.
CommitLanguages(ctx context.Context, in *CommitLanguagesRequest, opts ...grpc.CallOption) (*CommitLanguagesResponse, error)
- // This comment is left unintentionally blank.
+ // RawBlame blames lines in a blob to when they have last been changed. Returns the raw output of the git-blame(1)
+ // command.
RawBlame(ctx context.Context, in *RawBlameRequest, opts ...grpc.CallOption) (CommitService_RawBlameClient, error)
// LastCommitForPath returns the last commit that has changed a given path.
//
@@ -697,7 +698,8 @@ type CommitServiceServer interface {
// CommitLanguages detects the source code languages of the whole tree for a
// given commit. Returns an error in case no languages could be detected.
CommitLanguages(context.Context, *CommitLanguagesRequest) (*CommitLanguagesResponse, error)
- // This comment is left unintentionally blank.
+ // RawBlame blames lines in a blob to when they have last been changed. Returns the raw output of the git-blame(1)
+ // command.
RawBlame(*RawBlameRequest, CommitService_RawBlameServer) error
// LastCommitForPath returns the last commit that has changed a given path.
//