github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-03 17:30:00 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #8170 from wojtek-t/update_conversion_instructions

Browse Source 
Update instructions for generating conversions.
This commit is contained in:
Clayton Coleman 2015-05-13 13:16:23 -04:00
commit 82913c3112
1 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/devel/api_changes.md
View File

@ -227,18 +227,32 @@ Thus, we are auto-generating conversion functions that are much more efficient
than the generic ones (which are based on reflections and thus are highly than the generic ones (which are based on reflections and thus are highly
inefficient). inefficient).
The conversion code resides with each versioned API - The conversion code resides with each versioned API. There are two files:
`pkg/api/<version>/conversion.go`. To regenerate conversion functions: - `pkg/api/<version>/conversion.go` containing manually written conversion
functions
- `pkg/api/<version>/conversion_generated.go` containing auto-generated
conversion functions
Since auto-generated conversion functions are using manually written ones,
those manually written should be named with a defined convention, i.e. a function
converting type X in pkg a to type Y in pkg b, should be named:
`convert_a_X_To_b_Y`.
Also note that you can (and for efficiency reasons should) use auto-generated
conversion functions when writing your conversion functions.
Once all the necessary manually written conversions are added, you need to
regenerate auto-generated ones. To regenerate them:
- run - run
``` ```
$ go run cmd/kube-conversion/conversion.go -v <version> -f <file1.txt> -n <file2.txt> $ go run cmd/kube-conversion/conversion.go -v <version> -f <file1.txt> -n <file2.txt>
``` ```
- replace all conversion functions (convert\* functions) in the above file - replace all conversion functions (convert\* functions) in the
with the contents of \<file1.txt\> `pkg/api/<version>/conversion_generated.go` with the contents of \<file1.txt\>
- replace arguments of `newer.Scheme.AddGeneratedConversionFuncs` - replace arguments of `newer.Scheme.AddGeneratedConversionFuncs` in the
with the contents of \<file2.txt\> `pkg/api/<version>/conversion_generated.go` with the contents of \<file2.txt\>
Unsurprisingly, this also requires you to add tests to Unsurprisingly, adding manually written conversion also requires you to add tests to
`pkg/api/<version>/conversion_test.go`. `pkg/api/<version>/conversion_test.go`.
## Update the fuzzer ## Update the fuzzer