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:
authorJames Liu <jliu@gitlab.com>2023-10-09 06:05:58 +0300
committerJames Liu <jliu@gitlab.com>2023-10-12 08:17:04 +0300
commitac61012c72ac8abdf16288cc1849fb749501d07b (patch)
tree48d0cdac868297e5979a88971ae63664839c106c
parent0b63722f274fe3b5cebd00289de0e4cf647c69d0 (diff)
proto: Add missing docs for UserApplyPatch
-rw-r--r--internal/gitaly/service/operations/apply_patch.go2
-rw-r--r--proto/go/gitalypb/operations.pb.go4
-rw-r--r--proto/operations.proto4
3 files changed, 5 insertions, 5 deletions
diff --git a/internal/gitaly/service/operations/apply_patch.go b/internal/gitaly/service/operations/apply_patch.go
index 5381d90d0..d9978f50c 100644
--- a/internal/gitaly/service/operations/apply_patch.go
+++ b/internal/gitaly/service/operations/apply_patch.go
@@ -33,7 +33,7 @@ func (er gitError) Error() string {
return er.ErrMsg + ": " + er.Err.Error()
}
-//nolint:revive // This is unintentionally missing documentation.
+// UserApplyPatch applies patches to a given branch.
func (s *Server) UserApplyPatch(stream gitalypb.OperationService_UserApplyPatchServer) error {
firstRequest, err := stream.Recv()
if err != nil {
diff --git a/proto/go/gitalypb/operations.pb.go b/proto/go/gitalypb/operations.pb.go
index f8a4cb9ce..06dd30f8a 100644
--- a/proto/go/gitalypb/operations.pb.go
+++ b/proto/go/gitalypb/operations.pb.go
@@ -3655,7 +3655,7 @@ func (*UserSquashError_ResolveRevision) isUserSquashError_Error() {}
func (*UserSquashError_RebaseConflict) isUserSquashError_Error() {}
-// UserApplyPatchRequest ...
+// UserApplyPatchRequest is a request for the UserApplyPatch RPC.
type UserApplyPatchRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
@@ -3740,7 +3740,7 @@ func (*UserApplyPatchRequest_Header_) isUserApplyPatchRequest_UserApplyPatchRequ
func (*UserApplyPatchRequest_Patches) isUserApplyPatchRequest_UserApplyPatchRequestPayload() {}
-// UserApplyPatchResponse ...
+// UserApplyPatchResponse is a response for the UserApplyPatch RPC.
type UserApplyPatchResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
diff --git a/proto/operations.proto b/proto/operations.proto
index 83fe610ec..2a52f74ea 100644
--- a/proto/operations.proto
+++ b/proto/operations.proto
@@ -1009,7 +1009,7 @@ message UserSquashError {
}
}
-// UserApplyPatchRequest ...
+// UserApplyPatchRequest is a request for the UserApplyPatch RPC.
message UserApplyPatchRequest {
// Header contains information about how to apply the patches.
message Header {
@@ -1042,7 +1042,7 @@ message UserApplyPatchRequest {
}
}
-// UserApplyPatchResponse ...
+// UserApplyPatchResponse is a response for the UserApplyPatch RPC.
message UserApplyPatchResponse {
// branch_update contains information about the updated branch.
OperationBranchUpdate branch_update = 1;