go/vcs: add package comment

According to https://golang.org/doc/effective_go.html#commentary, "Every package should have a package comment." Updates golang/go#11490. GitHub-Last-Rev: 8dd80d0 GitHub-Pull-Request: #22 Change-Id: Ia3af83cc68bcde12c37492ad240031aecf6934a3 Reviewed-on: https://go-review.googlesource.com/93081 Reviewed-by: Brad Fitzpatrick <[email protected]>
golang · Feb 14, 2018 · a4ae709 · a4ae709
1 parent 7374a09
commit a4ae709
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/go/vcs/vcs.go b/go/vcs/vcs.go
@@ -2,6 +2,16 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package vcs exposes functions for resolving import paths
+// and using version control systems, which can be used to
+// implement behavior similar to the standard "go get" command.
+//
+// This package is a copy of internal code in package cmd/go/internal/get,
+// modified to make the identifiers exported. It's provided here
+// for developers who want to write tools with similar semantics.
+// It needs to be manually kept in sync with upstream when changes are
+// made to cmd/go/internal/get; see https://golang.org/issues/11490.
+//
 package vcs // import "golang.org/x/tools/go/vcs"
 
 import (