github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix sample-controller docs after moving to context-based cancellation

Browse Source 
Since the stop channels were replaced in e346475, the commentary is
incorrect and confusing.
This commit is contained in:
Matthew Huxtable
2023-03-24 15:39:19 +00:00
parent 0f373abb6a
commit 03be789851
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
staging/src/k8s.io/sample-controller/pkg/signals/signal.go
View File

@@ -24,9 +24,9 @@ import (
var onlyOneSignalHandler = make(chan struct{})
// SetupSignalHandler registered for SIGTERM and SIGINT. A stop channel is returned
// which is closed on one of these signals. If a second signal is caught, the program
// is terminated with exit code 1.
// SetupSignalHandler registered for SIGTERM and SIGINT. A context is returned
// which is cancelled on one of these signals. If a second signal is caught,
// the program is terminated with exit code 1.
func SetupSignalHandler() context.Context {
close(onlyOneSignalHandler) // panics when called twice