From b0573d526d5eb171e7e21edd642ffe5c258c37a7 Mon Sep 17 00:00:00 2001 From: Jordan Liggitt Date: Sat, 29 Aug 2020 10:40:33 -0400 Subject: [PATCH] Improve docs for client-go warning handlers --- staging/src/k8s.io/client-go/rest/config.go | 1 + staging/src/k8s.io/client-go/rest/warnings.go | 7 +++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/staging/src/k8s.io/client-go/rest/config.go b/staging/src/k8s.io/client-go/rest/config.go index 48cf51f651b..d4de8d207e9 100644 --- a/staging/src/k8s.io/client-go/rest/config.go +++ b/staging/src/k8s.io/client-go/rest/config.go @@ -125,6 +125,7 @@ type Config struct { // WarningHandler handles warnings in server responses. // If not set, the default warning handler is used. + // See documentation for SetDefaultWarningHandler() for details. WarningHandler WarningHandler // The maximum length of time to wait before giving up on a server request. A value of zero means no timeout. diff --git a/staging/src/k8s.io/client-go/rest/warnings.go b/staging/src/k8s.io/client-go/rest/warnings.go index 45c1c3b2cdb..18476f5ff90 100644 --- a/staging/src/k8s.io/client-go/rest/warnings.go +++ b/staging/src/k8s.io/client-go/rest/warnings.go @@ -38,8 +38,11 @@ var ( defaultWarningHandlerLock sync.RWMutex ) -// SetDefaultWarningHandler sets the default handler client uses when warning headers are encountered. -// By default, warnings are printed to stderr. +// SetDefaultWarningHandler sets the default handler clients use when warning headers are encountered. +// By default, warnings are logged. Several built-in implementations are provided: +// - NoWarnings suppresses warnings. +// - WarningLogger logs warnings. +// - NewWarningWriter() outputs warnings to the provided writer. func SetDefaultWarningHandler(l WarningHandler) { defaultWarningHandlerLock.Lock() defer defaultWarningHandlerLock.Unlock()