From ff5ddd0909f113e905786213e7b07aee1d3da341 Mon Sep 17 00:00:00 2001 From: Gyu-Ho Lee Date: Tue, 5 Jul 2016 09:55:44 -0700 Subject: [PATCH] Documentation: add instruction on vendoring, build Addressing https://github.com/coreos/etcd/issues/5857#issuecomment-230174840. --- Documentation/dl_build.md | 5 +++++ README.md | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/Documentation/dl_build.md b/Documentation/dl_build.md index 14ac4fd24..4350b9a4f 100644 --- a/Documentation/dl_build.md +++ b/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. [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: @@ -54,3 +56,6 @@ If OK is printed, then etcd is working! [github-release]: https://github.com/coreos/etcd/releases/ [go]: https://golang.org/doc/install +[build-script]: ../build +[cmd-directory]: ../cmd + diff --git a/README.md b/README.md index 30c16d9bf..29915b127 100644 --- a/README.md +++ b/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]. -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). 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. [github-release]: https://github.com/coreos/etcd/releases/ [branch-management]: ./Documentation/branch_management.md +[dl-build]: ./Documentation/dl_build.md#build-the-latest-version ### Running etcd