fluxcd
/
source-controller
mirror of https://github.com/fluxcd/source-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

controllers: finetune `eventLogf` (variant) docs 

Signed-off-by: Hidde Beydals <hello@hidde.co>
This commit is contained in:
Hidde Beydals 2022-03-10 18:26:52 +01:00
parent ff536e10bb
commit 971caf92d5
4 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
controllers/bucket_controller.go
View File

@ -642,7 +642,7 @@ func (r *BucketReconciler) getBucketSecret(ctx context.Context, obj *sourcev1.Bu
return secret, nil return secret, nil
} }
// eventLogf records event and logs at the same time. // eventLogf records events, and logs at the same time.
// //
// This log is different from the debug log in the EventRecorder, in the sense // This log is different from the debug log in the EventRecorder, in the sense
// that this is a simple log. While the debug log contains complete details // that this is a simple log. While the debug log contains complete details
@ -651,9 +651,10 @@ func (r *BucketReconciler) eventLogf(ctx context.Context, obj runtime.Object, ev
r.annotatedEventLogf(ctx, obj, nil, eventType, reason, messageFmt, args...) r.annotatedEventLogf(ctx, obj, nil, eventType, reason, messageFmt, args...)
} }
// annotatedEventLogf records annotated event and logs at the same time. This // annotatedEventLogf records annotated events, and logs at the same time.
// log is different from the debug log in the event recorder in the sense that //
// this is a simple log, the event recorder debug log contains complete details // This log is different from the debug log in the EventRecorder, in the sense
// that this is a simple log. While the debug log contains complete details
// about the event. // about the event.
func (r *BucketReconciler) annotatedEventLogf(ctx context.Context, func (r *BucketReconciler) annotatedEventLogf(ctx context.Context,
obj runtime.Object, annotations map[string]string, eventType string, reason string, messageFmt string, args ...interface{}) { obj runtime.Object, annotations map[string]string, eventType string, reason string, messageFmt string, args ...interface{}) {

2
controllers/gitrepository_controller.go
View File

@ -673,7 +673,7 @@ func (r *GitRepositoryReconciler) garbageCollect(ctx context.Context, obj *sourc
return nil return nil
} }
// eventLogf records event and logs at the same time. // eventLogf records events, and logs at the same time.
// //
// This log is different from the debug log in the EventRecorder, in the sense // This log is different from the debug log in the EventRecorder, in the sense
// that this is a simple log. While the debug log contains complete details // that this is a simple log. While the debug log contains complete details

2
controllers/helmchart_controller.go
View File

@ -952,7 +952,7 @@ func (r *HelmChartReconciler) requestsForBucketChange(o client.Object) []reconci
return reqs return reqs
} }
// eventLogf records event and logs at the same time. // eventLogf records events, and logs at the same time.
// //
// This log is different from the debug log in the EventRecorder, in the sense // This log is different from the debug log in the EventRecorder, in the sense
// that this is a simple log. While the debug log contains complete details // that this is a simple log. While the debug log contains complete details

2
controllers/helmrepository_controller.go
View File

@ -514,7 +514,7 @@ func (r *HelmRepositoryReconciler) garbageCollect(ctx context.Context, obj *sour
return nil return nil
} }
// eventLogf records event and logs at the same time. // eventLogf records events, and logs at the same time.
// //
// This log is different from the debug log in the EventRecorder, in the sense // This log is different from the debug log in the EventRecorder, in the sense
// that this is a simple log. While the debug log contains complete details // that this is a simple log. While the debug log contains complete details