Merge pull request kubernetes-client#771 from yue9944882/doc/java-model-gen-trimming-length

k8s-ci-robot · web-flow · commit e679a13248cf · 2019-11-03T10:51:39.000-08:00
Chore: Document "-l" option for the crd java model gen
diff --git a/docs/generate-model-from-third-party-resources.md b/docs/generate-model-from-third-party-resources.md
@@ -30,7 +30,9 @@ docker run -i --rm yue9944882/java-model-gen < /tmp/swagger | tar -xzf - -C /tmp
 ```
 
 By default, the package-name of generated codes will be `io.kubernetes.client`. If you want to override the package-name, consider 
-use `-p <package_name>` flag.
+use `-p <package_name>` flag. Additionally, you can use `-l <length>` option to make the generator to trim the length of generated 
+class name, the lower number generates shorter names. e.g. for a CRD named `crontabs.v1.example.io`, with `-l 1` the generated 
+name will be `CronTab`, otherwise with `-l3` it will be `ExampleV1Crontab`.
 
 ```
 docker run -i --rm yue9944882/java-model-gen -p com.example < /tmp/swagger | tar -xzf - -C /tmp/
