Skip to content

Commit 220c3f4

Browse files
authored
Merge pull request kubernetes#94331 from liggitt/warning-docs
Improve docs for client-go warning handlers
2 parents 1aec0a0 + b0573d5 commit 220c3f4

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

staging/src/k8s.io/client-go/rest/config.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ type Config struct {
125125

126126
// WarningHandler handles warnings in server responses.
127127
// If not set, the default warning handler is used.
128+
// See documentation for SetDefaultWarningHandler() for details.
128129
WarningHandler WarningHandler
129130

130131
// The maximum length of time to wait before giving up on a server request. A value of zero means no timeout.

staging/src/k8s.io/client-go/rest/warnings.go

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,11 @@ var (
3838
defaultWarningHandlerLock sync.RWMutex
3939
)
4040

41-
// SetDefaultWarningHandler sets the default handler client uses when warning headers are encountered.
42-
// By default, warnings are printed to stderr.
41+
// SetDefaultWarningHandler sets the default handler clients use when warning headers are encountered.
42+
// By default, warnings are logged. Several built-in implementations are provided:
43+
// - NoWarnings suppresses warnings.
44+
// - WarningLogger logs warnings.
45+
// - NewWarningWriter() outputs warnings to the provided writer.
4346
func SetDefaultWarningHandler(l WarningHandler) {
4447
defaultWarningHandlerLock.Lock()
4548
defer defaultWarningHandlerLock.Unlock()

0 commit comments

Comments
 (0)