1
0
mirror of https://github.com/golang/go synced 2024-11-23 12:10:11 -07:00

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>
This commit is contained in:
Matthew Dempsky 2016-04-14 18:51:18 -07:00
parent 1d214f7062
commit e7b96e1a1f

View File

@ -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 {