From 6ce5067117268eff1c9ca6077371d7c8f4d749e3 Mon Sep 17 00:00:00 2001 From: Marko Mudrinic Date: Thu, 15 Jun 2017 19:15:47 +0200 Subject: [PATCH] cmd/go: improve documentation on defaults for get The existing docs states that, get looks for a branch or tag that matches the locally installed version of Go. First, this is only working for "go1", so it could be confusing. Second, "If no such version exists it retrieves the most recent version of the package". It's more the default branch, by git defaults, rather than most recent version. This should address the potential unclear parts. Fixes #20320 Change-Id: Id7d727d88dc350c9902974b64fa28c3766f7e245 Reviewed-on: https://go-review.googlesource.com/45890 Reviewed-by: Ian Lance Taylor --- src/cmd/go/alldocs.go | 4 ++-- src/cmd/go/internal/get/get.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/cmd/go/alldocs.go b/src/cmd/go/alldocs.go index 8a5aa5bf4f..30af611b53 100644 --- a/src/cmd/go/alldocs.go +++ b/src/cmd/go/alldocs.go @@ -523,8 +523,8 @@ // When checking out or updating a package, get looks for a branch or tag // that matches the locally installed version of Go. The most important // rule is that if the local installation is running version "go1", get -// searches for a branch or tag named "go1". If no such version exists it -// retrieves the most recent version of the package. +// searches for a branch or tag named "go1". If no such version exists +// it retrieves the default branch of the package. // // When go get checks out or updates a Git repository, // it also updates any git submodules referenced by the repository. diff --git a/src/cmd/go/internal/get/get.go b/src/cmd/go/internal/get/get.go index 6291a72fc7..550321198d 100644 --- a/src/cmd/go/internal/get/get.go +++ b/src/cmd/go/internal/get/get.go @@ -60,8 +60,8 @@ get uses the first one. For more details see: 'go help gopath'. When checking out or updating a package, get looks for a branch or tag that matches the locally installed version of Go. The most important rule is that if the local installation is running version "go1", get -searches for a branch or tag named "go1". If no such version exists it -retrieves the most recent version of the package. +searches for a branch or tag named "go1". If no such version exists +it retrieves the default branch of the package. When go get checks out or updates a Git repository, it also updates any git submodules referenced by the repository.