added more comments

Signed-off-by: hillium <[email protected]>
pingcap · Nov 21, 2023 · d6c4847 · d6c4847
1 parent 2a9acf3
commit d6c4847
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 14 deletions.
diff --git a/pkg/brpb/brpb.pb.go b/pkg/brpb/brpb.pb.go
diff --git a/proto/brpb.proto b/proto/brpb.proto
@@ -27,20 +27,32 @@ enum PrepareSnapshotBackupRequestType {
 }
 
 message PrepareSnapshotBackupRequest {
+    // The type of the request.
     PrepareSnapshotBackupRequestType ty = 1;
+    // The regions related to the request.
+    // If the request is "UpdateLease" or "Finish", it should be empty.
     repeated metapb.Region regions = 2;
+    // The lease duration for "UpdateLease" request.
     uint64 lease_in_seconds = 3;
 }
 
 enum PrepareSnapshotBackupEventType {
+    // A region has finished wait apply.
     WaitApplyDone = 0;
+    // A lease has been updated.
     UpdateLeaseResult = 1;
 }
 
 message PrepareSnapshotBackupResponse {
+    // The type of the event.
     PrepareSnapshotBackupEventType ty = 1;
+    // The region bind to the type.
+    // For "WaitApplyDone".
     metapb.Region region = 2;
+    // The error of the execution.
     errorpb.Error error = 3;
+    // Whether the last lease is valid.
+    // For "UpdateLease" and "Finish".
     bool last_lease_is_valid = 4;
 }