github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-24 04:06:03 +00:00
Code Issues Projects Releases Wiki Activity

Fix instructions for client staging copy

Browse Source 
Following the existing instructions results in:

```
% ./staging/copy.sh
Do not run this script directly, but via hack/update-staging-client-go.sh.
```

Also format README.md as markdown.
This commit is contained in:
Lee Verberne 2017-05-08 10:35:41 -07:00
parent 843c40e32e
commit c92b818c92
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
staging/README.md
View File

@ -1,3 +1,15 @@
This staging/src/k8s.io/client-go directory is the staging area of the client repo. It contains a versioned client, tools built around the client like the reflector, and all the client dependencies. The content will be periodically published to k8s.io/client-go repo.
The staged content is copied from the main repo, i.e., k8s.io/kubernetes, with directory rearrangement and necessary rewritings. To sync the content with the latest code in your local k8s.io/kubernetes, you need to run `godep restore` in k8s root directory, then run staging/copy.sh.
vendor/k8s.io/client-go is a symlink pointing to this staging area, so to use the packages in the staging area, you can import it as "vendor/client-go/<package-name>", as if the client were vendored. The client will be vendored from k8s.io/client-go for real after the test matrix is converted to vendor k8s components.
This staging/src/k8s.io/client-go directory is the staging area of the client
repo. It contains a versioned client, tools built around the client like the
reflector, and all the client dependencies. The content will be periodically
published to k8s.io/client-go repo.
The staged content is copied from the main repo, i.e., k8s.io/kubernetes, with
directory rearrangement and necessary rewritings. To sync the content with the
latest code in your local k8s.io/kubernetes, you need to run `godep restore` in
k8s root directory, then run hack/update-staging-client-go.sh.
vendor/k8s.io/client-go is a symlink pointing to this staging area, so to use
the packages in the staging area, you can import it as
"vendor/client-go/<package-name>", as if the client were vendored. The client
will be vendored from k8s.io/client-go for real after the test matrix is
converted to vendor k8s components.