From ced85a85218389116cdc486bf4670139a17b197f Mon Sep 17 00:00:00 2001
From: Alexander Zielenski <351783+alexzielenski@users.noreply.github.com>
Date: Wed, 24 Aug 2022 10:12:41 -0700
Subject: [PATCH] update godoc

Kubernetes-commit: f94ef92f2ac44fb07bc8d75d5f250b757b343c11
---
 util/csaupgrade/upgrade.go | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/util/csaupgrade/upgrade.go b/util/csaupgrade/upgrade.go
index 33330358f..afd0391cf 100644
--- a/util/csaupgrade/upgrade.go
+++ b/util/csaupgrade/upgrade.go
@@ -11,7 +11,16 @@ import (
 
 // Upgrades the Manager information for fields managed with CSA
 // Prepares fields owned by `csaManager` for 'Update' operations for use now
-// with the given `ssaManager` for `Apply` operations
+// with the given `ssaManager` for `Apply` operations.
+//
+// Caveats:
+//  1. This operation is not reversible. Information about which fields the client
+//     owned will be lost in this operation.
+//  2. Supports being performed either before or after initial server-side apply.
+//  3. Client-side apply tends to own more fields (including fields that are defaulted),
+//     this will possibly remove this defaults, they will be re-defaulted, that's fine.
+//  4. Care must be taken to not overwrite the managed fields on the server if they
+//     have changed during the RMW operation.
 //
 // csaManager - Name of FieldManager formerly used for `Update` operations
 // ssaManager - Name of FieldManager formerly used for `Apply` operations