From 29b4de25b31c1b539017da43683012d986547bc1 Mon Sep 17 00:00:00 2001 From: Rob Pike Date: Mon, 16 Sep 2013 22:53:12 +1000 Subject: [PATCH] cmd/go: document that "main" is a reserved import path Fixes #6312. R=golang-dev, dave CC=golang-dev https://golang.org/cl/13391049 --- src/cmd/go/doc.go | 15 ++++++++++----- src/cmd/go/help.go | 15 ++++++++++----- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/src/cmd/go/doc.go b/src/cmd/go/doc.go index 7af623ae1b..46905c1cf9 100644 --- a/src/cmd/go/doc.go +++ b/src/cmd/go/doc.go @@ -542,12 +542,17 @@ environment variable (see 'go help gopath'). If no import paths are given, the action applies to the package in the current directory. -The special import path "all" expands to all package directories -found in all the GOPATH trees. For example, 'go list all' -lists all the packages on the local system. +There are three reserved names for paths that should not be used +for packages to be built with the go tool: -The special import path "std" is like all but expands to just the -packages in the standard Go library. +- "main" denotes the top-level package in a stand-alone executable. + +- "all" expands to all package directories found in all the GOPATH +trees. For example, 'go list all' lists all the packages on the local +system. + +- "std" is like all but expands to just the packages in the standard +Go library. An import path is a pattern if it includes one or more "..." wildcards, each of which can match any string, including the empty string and diff --git a/src/cmd/go/help.go b/src/cmd/go/help.go index c1aa32a539..8028fe8a9e 100644 --- a/src/cmd/go/help.go +++ b/src/cmd/go/help.go @@ -25,12 +25,17 @@ environment variable (see 'go help gopath'). If no import paths are given, the action applies to the package in the current directory. -The special import path "all" expands to all package directories -found in all the GOPATH trees. For example, 'go list all' -lists all the packages on the local system. +There are three reserved names for paths that should not be used +for packages to be built with the go tool: -The special import path "std" is like all but expands to just the -packages in the standard Go library. +- "main" denotes the top-level package in a stand-alone executable. + +- "all" expands to all package directories found in all the GOPATH +trees. For example, 'go list all' lists all the packages on the local +system. + +- "std" is like all but expands to just the packages in the standard +Go library. An import path is a pattern if it includes one or more "..." wildcards, each of which can match any string, including the empty string and -- 2.48.1