]> Cypherpunks repositories - gostls13.git/commitdiff
cmd/internal/sys: cleanup documentation
authorMatthew Dempsky <mdempsky@google.com>
Fri, 15 Apr 2016 01:51:18 +0000 (18:51 -0700)
committerMatthew Dempsky <mdempsky@google.com>
Fri, 15 Apr 2016 02:07:38 +0000 (02:07 +0000)
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>
src/cmd/internal/sys/arch.go

index 0dc7cb814b993ab42d0a9fd8630ffdf59aa83938..18accdeb0c26ec8e63e38d98934bd1dfaaafcd24 100644 (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 {