Commit e357eb97 authored by Russ Cox's avatar Russ Cox

cmd/go: document that package documentation is ignored

Fixes #11801.

Change-Id: I2caeac7fdddc7f29015d6db8d4b3e296c8b9c423
Reviewed-on: https://go-review.googlesource.com/17954Reviewed-by: default avatarBrad Fitzpatrick <bradfitz@golang.org>
parent aaa0bc10
...@@ -79,6 +79,14 @@ internally at Google all begin with 'google', and paths ...@@ -79,6 +79,14 @@ internally at Google all begin with 'google', and paths
denoting remote repositories begin with the path to the code, denoting remote repositories begin with the path to the code,
such as 'github.com/user/repo'. such as 'github.com/user/repo'.
Packages in a program need not have unique package names,
but there are two reserved package names with special meaning.
The name main indicates a command, not a library.
Commands are built into binaries and cannot be imported.
The name documentation indicates documentation for
a non-Go program in the directory. Files in package documentation
are ignored by the go command.
As a special case, if the package list is a list of .go files from a As a special case, if the package list is a list of .go files from a
single directory, the command is applied to a single synthesized single directory, the command is applied to a single synthesized
package made up of exactly those files, ignoring any build constraints package made up of exactly those files, ignoring any build constraints
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment