diff options
| author | k8s-merge-robot <k8s.production.user@gmail.com> | 2016-07-07 21:25:10 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-07-07 21:25:10 -0700 |
| commit | 3bc5017e01c48bca76c1310836df9be953ad8248 (patch) | |
| tree | 8ac1a06e6cae63eb4cd1b30d07012c536ae11b5a | |
| parent | a96008ab101df6eb2e24ec5fde23febe2fbe6e63 (diff) | |
| parent | 19bae12d22d75293cb96702caa3f7dbfe5ae8e0c (diff) | |
Merge pull request #28578 from thockin/dont-checkin-generated-code-prep-1
Automatic merge from submit-queue
Prep for not checking in generated, part 1/2
This PR is extracted from #25978 - it is just the deep-copy related parts. All the Makefile and conversion stuff is excluded.
@wojtek-t this is literally branched, a bunch of commits deleted, and a very small number of manual fixups applied. If you think this is easier to review (and if it passes CI) you can feel free to go over it again. I will follow this with a conversion-related PR to build on this.
Or if you prefer, just close this and let the mega-PR ride.
@lavalamp
| -rw-r--r-- | adding-an-APIGroup.md | 8 | ||||
| -rw-r--r-- | api_changes.md | 9 |
2 files changed, 9 insertions, 8 deletions
diff --git a/adding-an-APIGroup.md b/adding-an-APIGroup.md index c2197761..63c4e2a2 100644 --- a/adding-an-APIGroup.md +++ b/adding-an-APIGroup.md @@ -75,12 +75,14 @@ cmd/libs/go2idl/ tool. 1. Generate conversions and deep-copies: 1. Add your "group/" or "group/version" into - cmd/libs/go2idl/{conversion-gen, deep-copy-gen}/main.go; + cmd/libs/go2idl/conversion-gen/main.go; 2. Make sure your pkg/apis/`<group>`/`<version>` directory has a doc.go file + with the comment `// +k8s:deepcopy-gen=package,register`, to catch the + attention of our generation tools. + 3. Make sure your pkg/apis/`<group>`/`<version>` directory has a doc.go file with the comment `// +genconversion=true`, to catch the attention of our gen-conversion script. - 3. Run hack/update-all.sh. - + 4. Run hack/update-all.sh. 2. Generate files for Ugorji codec: diff --git a/api_changes.md b/api_changes.md index c95d0736..d5ead760 100644 --- a/api_changes.md +++ b/api_changes.md @@ -468,12 +468,11 @@ regenerate auto-generated ones. To regenerate them run: hack/update-codegen.sh ``` -update-codegen will also 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 - - `pkg/apis/extensions/<version>/deep_copy_generated.go` containing auto-generated copy functions +As part of the build, kubernetes will also generate code to handle deep copy of +your versioned api objects. The deep copy code resides with each versioned API: + - `<path_to_versioned_api>/zz_generated.deep_copy.go` containing auto-generated copy functions -If running the above script is impossible due to compile errors, the easiest +If regeneration is somehow not possible due to compile errors, the easiest workaround is to comment out the code causing errors and let the script to regenerate it. If the auto-generated conversion methods are not used by the manually-written ones, it's fine to just remove the whole file and let the |