diff options
| author | Matthew Dempsky <mdempsky@google.com> | 2016-04-14 18:51:18 -0700 |
|---|---|---|
| committer | Matthew Dempsky <mdempsky@google.com> | 2016-04-15 02:07:38 +0000 |
| commit | e7b96e1a1f1ead0d5def61f339e446c3afefa617 (patch) | |
| tree | dbd9eab6adbbeabf97cf936ca72cbf8a97803724 /src | |
| parent | 1d214f7062e80bebb081cdfad2ceda3e5bd0de29 (diff) | |
| download | go-e7b96e1a1f1ead0d5def61f339e446c3afefa617.tar.xz | |
cmd/internal/sys: cleanup documentation
Expand description of ArchFamily, because it seems to be a common
source of confusion. Also, update InFamily's description to reflect
current name.
Change-Id: I66b7999aef64ab8fee39aec0f752ae4f3a08d36d
Reviewed-on: https://go-review.googlesource.com/22102
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Diffstat (limited to 'src')
| -rw-r--r-- | src/cmd/internal/sys/arch.go | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/cmd/internal/sys/arch.go b/src/cmd/internal/sys/arch.go index 0dc7cb814b..18accdeb0c 100644 --- a/src/cmd/internal/sys/arch.go +++ b/src/cmd/internal/sys/arch.go @@ -6,7 +6,9 @@ package sys import "encoding/binary" -// ArchFamily represents an architecture family. +// ArchFamily represents a family of one or more related architectures. +// For example, amd64 and amd64p32 are both members of the AMD64 family, +// and ppc64 and ppc64le are both members of the PPC64 family. type ArchFamily byte const ( @@ -34,7 +36,7 @@ type Arch struct { MinLC int } -// HasFamily reports whether a is a member of any of the specified +// InFamily reports whether a is a member of any of the specified // architecture families. func (a *Arch) InFamily(xs ...ArchFamily) bool { for _, x := range xs { |