From fad9dec758be4dcc49735aea98ada2de46cff9fe Mon Sep 17 00:00:00 2001 From: Mike Spreitzer Date: Sat, 4 May 2019 23:27:42 -0400 Subject: [PATCH] Fix comment on SharedInformer.Run The old wording suggested that `Run` only gets the controller started. Changed the wording to make it clear that `Run` only returns after the controller is stopped. --- staging/src/k8s.io/client-go/tools/cache/shared_informer.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/staging/src/k8s.io/client-go/tools/cache/shared_informer.go b/staging/src/k8s.io/client-go/tools/cache/shared_informer.go index 9715d344ecc..5bc1b0ff9b7 100644 --- a/staging/src/k8s.io/client-go/tools/cache/shared_informer.go +++ b/staging/src/k8s.io/client-go/tools/cache/shared_informer.go @@ -53,7 +53,8 @@ type SharedInformer interface { GetStore() Store // GetController gives back a synthetic interface that "votes" to start the informer GetController() Controller - // Run starts the shared informer, which will be stopped when stopCh is closed. + // Run starts and runs the shared informer, returning after it stops. + // The informer will be stopped when stopCh is closed. Run(stopCh <-chan struct{}) // HasSynced returns true if the shared informer's store has synced. HasSynced() bool