summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorderekwaynecarr <decarr@redhat.com>2015-08-10 12:22:44 -0400
committerderekwaynecarr <decarr@redhat.com>2015-08-24 14:28:53 -0400
commit96988acedbfedc32087610a04d4b8fb6ead25b4e (patch)
tree1eba72a26c43682c0dc86ff6aeb730dce3f7f671
parent66a9ff2d9b98120b3c9afe832f72e35dc22d301a (diff)
Document need to run generated deep copy
-rw-r--r--api_changes.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/api_changes.md b/api_changes.md
index 687af00a..5c2c4a2a 100644
--- a/api_changes.md
+++ b/api_changes.md
@@ -297,6 +297,22 @@ generator to create it from scratch.
Unsurprisingly, adding manually written conversion also requires you to add tests to
`pkg/api/<version>/conversion_test.go`.
+## Edit deep copy files
+
+At this point you have both the versioned API changes and the internal
+structure changes done. You now need to generate code to handle deep copy
+of your versioned api objects.
+
+The deep copy code resides with each versioned API:
+ - `pkg/api/<version>/deep_copy_generated.go` containing auto-generated copy functions
+
+To regenerate them:
+ - run
+
+```sh
+hack/update-generated-deep-copies.sh
+```
+
## Update the fuzzer
Part of our testing regimen for APIs is to "fuzz" (fill with random values) API