benchmark: fix install docs #10473
benchmark: fix install docs #10473
Conversation
tools/benchmark/README.md
Outdated
| ## Download | ||
| To get `etcd` from the `master` branch via `go get`: | ||
| ```sh | ||
| go get github.com/coreos/etcd/tools/benchmark |
There was a problem hiding this comment.
My understanding is that 'go get' will perform download AND install.
There was a problem hiding this comment.
Thanks, how about now?
haroldHT
force-pushed
the
master
branch
2 times, most recently
from
c8dc45c to
7b0b98b
Compare
Codecov Report
@@ Coverage Diff @@
## master #10473 +/- ##
==========================================
+ Coverage 71.57% 71.6% +0.03%
==========================================
Files 392 392
Lines 36518 36518
==========================================
+ Hits 26136 26147 +11
+ Misses 8552 8550 -2
+ Partials 1830 1821 -9
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
My understanding of the confusion in #10453 is the following. After user run 'go get ...' command, which performs download and install, he/she cannot find where the benchmark executable is located. If this is the case, I believe it is a standard setting issue regarding $GOPATH and $PATH, not specific to this benchmark tool. To make the doc more clear to new users, we need something similar to https://github.com/etcd-io/etcd/blob/master/Documentation/dl_build.md#build-the-latest-version
tools/benchmark/README.md
Outdated
| ```bash | ||
| go get github.com/coreos/etcd/tools/benchmark | ||
| ## Download and install | ||
| To get `etcd` from the `master` branch via `go get`: |
tools/benchmark/README.md
Outdated
| ## Download and install | ||
| To get `benchmark` from the `master` branch via `go get`: | ||
| ```sh | ||
| $ go get github.com/coreos/etcd/tools/benchmark |
There was a problem hiding this comment.
Sorry I forgot to mention in my previous comment, can we also update the link to:
go get go.etcd.io/etcd/tools/benchmark
The etcd repo was moved to go.etcd.io (see #9965). Both links work because github is redirecting the old url to the new one. But I think it is better we update the link to reflect the new repo name.
|
|
lgtm |
#10463