Merge pull request #1587 from aaronlehmann/build-docs
docs: No need to change GOPATH to use vendored code
This commit is contained in:
commit
2c803d6fd0
1 changed files with 1 additions and 28 deletions
|
@ -85,7 +85,7 @@ Please install the following into `GOPATH` for it to work:
|
||||||
Once these commands are available in the `GOPATH`, run `make` to get a full
|
Once these commands are available in the `GOPATH`, run `make` to get a full
|
||||||
build:
|
build:
|
||||||
|
|
||||||
$ GOPATH=`godep path`:$GOPATH make
|
$ make
|
||||||
+ clean
|
+ clean
|
||||||
+ fmt
|
+ fmt
|
||||||
+ vet
|
+ vet
|
||||||
|
@ -120,33 +120,6 @@ the registry binary generated in the "./bin" directory:
|
||||||
$ ./bin/registry -version
|
$ ./bin/registry -version
|
||||||
./bin/registry github.com/docker/distribution v2.0.0-alpha.2-80-g16d8b2c.m
|
./bin/registry github.com/docker/distribution v2.0.0-alpha.2-80-g16d8b2c.m
|
||||||
|
|
||||||
### Developing
|
|
||||||
|
|
||||||
The above approaches are helpful for small experimentation. If more complex
|
|
||||||
tasks are at hand, it is recommended to employ the full power of `godep`.
|
|
||||||
|
|
||||||
The Makefile is designed to have its `GOPATH` defined externally. This allows
|
|
||||||
one to experiment with various development environment setups. This is
|
|
||||||
primarily useful when testing upstream bugfixes, by modifying local code. This
|
|
||||||
can be demonstrated using `godep` to migrate the `GOPATH` to use the specified
|
|
||||||
dependencies. The `GOPATH` can be migrated to the current package versions
|
|
||||||
declared in `Godeps` with the following command:
|
|
||||||
|
|
||||||
godep restore
|
|
||||||
|
|
||||||
> **WARNING:** This command will checkout versions of the code specified in
|
|
||||||
> Godeps/Godeps.json, modifying the contents of `GOPATH`. If this is
|
|
||||||
> undesired, it is recommended to create a workspace devoted to work on the
|
|
||||||
> _Distribution_ project.
|
|
||||||
|
|
||||||
With a successful run of the above command, one can now use `make` without
|
|
||||||
specifying the `GOPATH`:
|
|
||||||
|
|
||||||
make
|
|
||||||
|
|
||||||
If that is successful, standard `go` commands, such as `go test` should work,
|
|
||||||
per package, without issue.
|
|
||||||
|
|
||||||
### Optional build tags
|
### Optional build tags
|
||||||
|
|
||||||
Optional [build tags](http://golang.org/pkg/go/build/) can be provided using
|
Optional [build tags](http://golang.org/pkg/go/build/) can be provided using
|
||||||
|
|
Loading…
Reference in a new issue