From c92b818c921b5a6dd0c7e5d40157feb170a69d76 Mon Sep 17 00:00:00 2001 From: Lee Verberne Date: Mon, 8 May 2017 10:35:41 -0700 Subject: [PATCH] Fix instructions for client staging copy 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. --- staging/README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/staging/README.md b/staging/README.md index 9a81c7ba574..f8bf99595fd 100644 --- a/staging/README.md +++ b/staging/README.md @@ -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/", 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/", 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.