Browse Source

Merge pull request #5872 from gyuho/build_doc

Documentation: add instruction on vendoring, build
Gyu-Ho Lee 9 years ago
parent
commit
beab76c7a9
2 changed files with 7 additions and 1 deletions
  1. 5 0
      Documentation/dl_build.md
  2. 2 1
      README.md

+ 5 - 0
Documentation/dl_build.md

@@ -12,6 +12,8 @@ The easiest way to get etcd is to use one of the pre-built release binaries whic
 
 
 For those wanting to try the very latest version, build etcd from the `master` branch.
 For those wanting to try the very latest version, build etcd from the `master` branch.
 [Go](https://golang.org/) version 1.6+ (with HTTP2 support) is required to build the latest version of etcd.
 [Go](https://golang.org/) version 1.6+ (with HTTP2 support) is required to build the latest version of etcd.
+etcd vendors its dependency for official release binaries, while making vendoring optional to avoid import conflicts.
+[`build` script][build-script] would automatically include the vendored dependencies from [`cmd`][cmd-directory] directory.  
 
 
 Here are the commands to build an etcd binary from the `master` branch:
 Here are the commands to build an etcd binary from the `master` branch:
 
 
@@ -54,3 +56,6 @@ If OK is printed, then etcd is working!
 
 
 [github-release]: https://github.com/coreos/etcd/releases/
 [github-release]: https://github.com/coreos/etcd/releases/
 [go]: https://golang.org/doc/install
 [go]: https://golang.org/doc/install
+[build-script]: ../build
+[cmd-directory]: ../cmd
+

+ 2 - 1
README.md

@@ -39,13 +39,14 @@ See [etcdctl][etcdctl] for a simple command line client.
 
 
 The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, AppC (ACI), and Docker. Instructions for using these binaries are on the [GitHub releases page][github-release].
 The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, AppC (ACI), and Docker. Instructions for using these binaries are on the [GitHub releases page][github-release].
 
 
-For those wanting to try the very latest version, you can build the latest version of etcd from the `master` branch.
+For those wanting to try the very latest version, you can [build the latest version of etcd][dl-build] from the `master` branch.
 You will first need [*Go*](https://golang.org/) installed on your machine (version 1.6+ is required).
 You will first need [*Go*](https://golang.org/) installed on your machine (version 1.6+ is required).
 All development occurs on `master`, including new features and bug fixes.
 All development occurs on `master`, including new features and bug fixes.
 Bug fixes are first targeted at `master` and subsequently ported to release branches, as described in the [branch management][branch-management] guide.
 Bug fixes are first targeted at `master` and subsequently ported to release branches, as described in the [branch management][branch-management] guide.
 
 
 [github-release]: https://github.com/coreos/etcd/releases/
 [github-release]: https://github.com/coreos/etcd/releases/
 [branch-management]: ./Documentation/branch_management.md
 [branch-management]: ./Documentation/branch_management.md
+[dl-build]: ./Documentation/dl_build.md#build-the-latest-version
 
 
 ### Running etcd
 ### Running etcd