all: use "reports whether" consistently instead of "returns whether"

Follow-up for CL 147037 and after Brad noticed the "returns whether"
pattern during the review of CL 150621.

Go documentation style for boolean funcs is to say:

    // Foo reports whether ...
    func Foo() bool

(rather than "returns whether")

Created with:

    $ perl -i -npe 's/returns whether/reports whether/' $(git grep -l "returns whether" | grep -v vendor)

Change-Id: I15fe9ff99180ad97750cd05a10eceafdb12dc0b4
Reviewed-on: https://go-review.googlesource.com/c/150918
Run-TryBot: Tobias Klauser <tobias.klauser@gmail.com>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
This commit is contained in:
Tobias Klauser 2018-11-22 11:46:44 +01:00 committed by Tobias Klauser
parent b397248168
commit 9e277f7d55
51 changed files with 64 additions and 64 deletions

View file

@ -68,7 +68,7 @@ func (b *Buffer) String() string {
return string(b.buf[b.off:]) return string(b.buf[b.off:])
} }
// empty returns whether the unread portion of the buffer is empty. // empty reports whether the unread portion of the buffer is empty.
func (b *Buffer) empty() bool { return len(b.buf) <= b.off } func (b *Buffer) empty() bool { return len(b.buf) <= b.off }
// Len returns the number of bytes of the unread portion of the buffer; // Len returns the number of bytes of the unread portion of the buffer;

View file

@ -718,7 +718,7 @@ func (p *Package) mangleName(n *Name) {
// rewriteCalls rewrites all calls that pass pointers to check that // rewriteCalls rewrites all calls that pass pointers to check that
// they follow the rules for passing pointers between Go and C. // they follow the rules for passing pointers between Go and C.
// This returns whether the package needs to import unsafe as _cgo_unsafe. // This reports whether the package needs to import unsafe as _cgo_unsafe.
func (p *Package) rewriteCalls(f *File) bool { func (p *Package) rewriteCalls(f *File) bool {
needsUnsafe := false needsUnsafe := false
// Walk backward so that in C.f1(C.f2()) we rewrite C.f2 first. // Walk backward so that in C.f1(C.f2()) we rewrite C.f2 first.
@ -941,7 +941,7 @@ func (p *Package) rewriteCall(f *File, call *Call) (string, bool) {
return sb.String(), needsUnsafe return sb.String(), needsUnsafe
} }
// needsPointerCheck returns whether the type t needs a pointer check. // needsPointerCheck reports whether the type t needs a pointer check.
// This is true if t is a pointer and if the value to which it points // This is true if t is a pointer and if the value to which it points
// might contain a pointer. // might contain a pointer.
func (p *Package) needsPointerCheck(f *File, t ast.Expr, arg ast.Expr) bool { func (p *Package) needsPointerCheck(f *File, t ast.Expr, arg ast.Expr) bool {
@ -958,7 +958,7 @@ func (p *Package) needsPointerCheck(f *File, t ast.Expr, arg ast.Expr) bool {
// hasPointer is used by needsPointerCheck. If top is true it returns // hasPointer is used by needsPointerCheck. If top is true it returns
// whether t is or contains a pointer that might point to a pointer. // whether t is or contains a pointer that might point to a pointer.
// If top is false it returns whether t is or contains a pointer. // If top is false it reports whether t is or contains a pointer.
// f may be nil. // f may be nil.
func (p *Package) hasPointer(f *File, t ast.Expr, top bool) bool { func (p *Package) hasPointer(f *File, t ast.Expr, top bool) bool {
switch t := t.(type) { switch t := t.(type) {
@ -1172,7 +1172,7 @@ func (p *Package) checkAddr(sb, sbCheck *bytes.Buffer, arg ast.Expr, i int) bool
return true return true
} }
// isType returns whether the expression is definitely a type. // isType reports whether the expression is definitely a type.
// This is conservative--it returns false for an unknown identifier. // This is conservative--it returns false for an unknown identifier.
func (p *Package) isType(t ast.Expr) bool { func (p *Package) isType(t ast.Expr) bool {
switch t := t.(type) { switch t := t.(type) {
@ -1214,7 +1214,7 @@ func (p *Package) isType(t ast.Expr) bool {
return false return false
} }
// isConst returns whether x is an untyped constant expression. // isConst reports whether x is an untyped constant expression.
func (p *Package) isConst(f *File, x ast.Expr) bool { func (p *Package) isConst(f *File, x ast.Expr) bool {
switch x := x.(type) { switch x := x.(type) {
case *ast.BasicLit: case *ast.BasicLit:
@ -2827,7 +2827,7 @@ func (c *typeConv) Struct(dt *dwarf.StructType, pos token.Pos) (expr *ast.Struct
return return
} }
// dwarfHasPointer returns whether the DWARF type dt contains a pointer. // dwarfHasPointer reports whether the DWARF type dt contains a pointer.
func (c *typeConv) dwarfHasPointer(dt dwarf.Type, pos token.Pos) bool { func (c *typeConv) dwarfHasPointer(dt dwarf.Type, pos token.Pos) bool {
switch dt := dt.(type) { switch dt := dt.(type) {
default: default:

View file

@ -1203,7 +1203,7 @@ func (p *Package) writeExportHeader(fgcch io.Writer) {
fmt.Fprintf(fgcch, "%s\n", p.gccExportHeaderProlog()) fmt.Fprintf(fgcch, "%s\n", p.gccExportHeaderProlog())
} }
// gccgoUsesNewMangling returns whether gccgo uses the new collision-free // gccgoUsesNewMangling reports whether gccgo uses the new collision-free
// packagepath mangling scheme (see determineGccgoManglingScheme for more // packagepath mangling scheme (see determineGccgoManglingScheme for more
// info). // info).
func gccgoUsesNewMangling() bool { func gccgoUsesNewMangling() bool {

View file

@ -915,7 +915,7 @@ func dcommontype(lsym *obj.LSym, t *types.Type) int {
return ot return ot
} }
// typeHasNoAlg returns whether t does not have any associated hash/eq // typeHasNoAlg reports whether t does not have any associated hash/eq
// algorithms because t, or some component of t, is marked Noalg. // algorithms because t, or some component of t, is marked Noalg.
func typeHasNoAlg(t *types.Type) bool { func typeHasNoAlg(t *types.Type) bool {
a, bad := algtype1(t) a, bad := algtype1(t)

View file

@ -14,12 +14,12 @@ import (
"cmd/internal/obj/mips" "cmd/internal/obj/mips"
) )
// isFPreg returns whether r is an FP register // isFPreg reports whether r is an FP register
func isFPreg(r int16) bool { func isFPreg(r int16) bool {
return mips.REG_F0 <= r && r <= mips.REG_F31 return mips.REG_F0 <= r && r <= mips.REG_F31
} }
// isHILO returns whether r is HI or LO register // isHILO reports whether r is HI or LO register
func isHILO(r int16) bool { func isHILO(r int16) bool {
return r == mips.REG_HI || r == mips.REG_LO return r == mips.REG_HI || r == mips.REG_LO
} }

View file

@ -14,12 +14,12 @@ import (
"cmd/internal/obj/mips" "cmd/internal/obj/mips"
) )
// isFPreg returns whether r is an FP register // isFPreg reports whether r is an FP register
func isFPreg(r int16) bool { func isFPreg(r int16) bool {
return mips.REG_F0 <= r && r <= mips.REG_F31 return mips.REG_F0 <= r && r <= mips.REG_F31
} }
// isHILO returns whether r is HI or LO register // isHILO reports whether r is HI or LO register
func isHILO(r int16) bool { func isHILO(r int16) bool {
return r == mips.REG_HI || r == mips.REG_LO return r == mips.REG_HI || r == mips.REG_LO
} }

View file

@ -43,7 +43,7 @@ func (s *biasedSparseMap) size() int {
return s.s.size() return s.s.size()
} }
// contains returns whether x is a key in s // contains reports whether x is a key in s
func (s *biasedSparseMap) contains(x uint) bool { func (s *biasedSparseMap) contains(x uint) bool {
if s.s == nil { if s.s == nil {
return false return false

View file

@ -164,7 +164,7 @@ type Frontend interface {
// given name. // given name.
Syslook(string) *obj.LSym Syslook(string) *obj.LSym
// UseWriteBarrier returns whether write barrier is enabled // UseWriteBarrier reports whether write barrier is enabled
UseWriteBarrier() bool UseWriteBarrier() bool
// SetWBPos indicates that a write barrier has been inserted // SetWBPos indicates that a write barrier has been inserted

View file

@ -83,7 +83,7 @@ import "math/big"
// a+b has n+1 bits in it. Nevertheless, can be done // a+b has n+1 bits in it. Nevertheless, can be done
// in 2 instructions on x86.) // in 2 instructions on x86.)
// umagicOK returns whether we should strength reduce a n-bit divide by c. // umagicOK reports whether we should strength reduce a n-bit divide by c.
func umagicOK(n uint, c int64) bool { func umagicOK(n uint, c int64) bool {
// Convert from ConstX auxint values to the real uint64 constant they represent. // Convert from ConstX auxint values to the real uint64 constant they represent.
d := uint64(c) << (64 - n) >> (64 - n) d := uint64(c) << (64 - n) >> (64 - n)

View file

@ -20,7 +20,7 @@ func isPoorStatementOp(op Op) bool {
return false return false
} }
// LosesStmtMark returns whether a prog with op as loses its statement mark on the way to DWARF. // LosesStmtMark reports whether a prog with op as loses its statement mark on the way to DWARF.
// The attributes from some opcodes are lost in translation. // The attributes from some opcodes are lost in translation.
// TODO: this is an artifact of how funcpctab combines information for instructions at a single PC. // TODO: this is an artifact of how funcpctab combines information for instructions at a single PC.
// Should try to fix it there. // Should try to fix it there.

View file

@ -320,7 +320,7 @@ func canMergeLoad(target, load *Value) bool {
return true return true
} }
// isSameSym returns whether sym is the same as the given named symbol // isSameSym reports whether sym is the same as the given named symbol
func isSameSym(sym interface{}, name string) bool { func isSameSym(sym interface{}, name string) bool {
s, ok := sym.(fmt.Stringer) s, ok := sym.(fmt.Stringer)
return ok && s.String() == name return ok && s.String() == name

View file

@ -300,7 +300,7 @@ func (v *Value) Fatalf(msg string, args ...interface{}) {
v.Block.Func.fe.Fatalf(v.Pos, msg, args...) v.Block.Func.fe.Fatalf(v.Pos, msg, args...)
} }
// isGenericIntConst returns whether v is a generic integer constant. // isGenericIntConst reports whether v is a generic integer constant.
func (v *Value) isGenericIntConst() bool { func (v *Value) isGenericIntConst() bool {
return v != nil && (v.Op == OpConst64 || v.Op == OpConst32 || v.Op == OpConst16 || v.Op == OpConst8) return v != nil && (v.Op == OpConst64 || v.Op == OpConst32 || v.Op == OpConst16 || v.Op == OpConst8)
} }

View file

@ -11,7 +11,7 @@ import (
"strings" "strings"
) )
// needwb returns whether we need write barrier for store op v. // needwb reports whether we need write barrier for store op v.
// v must be Store/Move/Zero. // v must be Store/Move/Zero.
func needwb(v *Value) bool { func needwb(v *Value) bool {
t, ok := v.Aux.(*types.Type) t, ok := v.Aux.(*types.Type)

View file

@ -1457,7 +1457,7 @@ func Haspointers1(t *Type, ignoreNotInHeap bool) bool {
return true return true
} }
// HasHeapPointer returns whether t contains a heap pointer. // HasHeapPointer reports whether t contains a heap pointer.
// This is used for write barrier insertion, so it ignores // This is used for write barrier insertion, so it ignores
// pointers to go:notinheap types. // pointers to go:notinheap types.
func (t *Type) HasHeapPointer() bool { func (t *Type) HasHeapPointer() bool {

View file

@ -1183,7 +1183,7 @@ func isaddcon(v int64) bool {
return v <= 0xFFF return v <= 0xFFF
} }
// isbitcon returns whether a constant can be encoded into a logical instruction. // isbitcon reports whether a constant can be encoded into a logical instruction.
// bitcon has a binary form of repetition of a bit sequence of length 2, 4, 8, 16, 32, or 64, // bitcon has a binary form of repetition of a bit sequence of length 2, 4, 8, 16, 32, or 64,
// which itself is a rotate (w.r.t. the length of the unit) of a sequence of ones. // which itself is a rotate (w.r.t. the length of the unit) of a sequence of ones.
// special cases: 0 and -1 are not bitcon. // special cases: 0 and -1 are not bitcon.

View file

@ -198,7 +198,7 @@ const (
R_WASMIMPORT R_WASMIMPORT
) )
// IsDirectJump returns whether r is a relocation for a direct jump. // IsDirectJump reports whether r is a relocation for a direct jump.
// A direct jump is a CALL or JMP instruction that takes the target address // A direct jump is a CALL or JMP instruction that takes the target address
// as immediate. The address is embedded into the instruction, possibly // as immediate. The address is embedded into the instruction, possibly
// with limited width. // with limited width.

View file

@ -48,7 +48,7 @@ import (
"sync" "sync"
) )
// isRuntimeDepPkg returns whether pkg is the runtime package or its dependency // isRuntimeDepPkg reports whether pkg is the runtime package or its dependency
func isRuntimeDepPkg(pkg string) bool { func isRuntimeDepPkg(pkg string) bool {
switch pkg { switch pkg {
case "runtime", case "runtime",

View file

@ -158,7 +158,7 @@ const (
MINFUNC = 16 // minimum size for a function MINFUNC = 16 // minimum size for a function
) )
// DynlinkingGo returns whether we are producing Go code that can live // DynlinkingGo reports whether we are producing Go code that can live
// in separate shared libraries linked together at runtime. // in separate shared libraries linked together at runtime.
func (ctxt *Link) DynlinkingGo() bool { func (ctxt *Link) DynlinkingGo() bool {
if !ctxt.Loaded { if !ctxt.Loaded {
@ -167,12 +167,12 @@ func (ctxt *Link) DynlinkingGo() bool {
return ctxt.BuildMode == BuildModeShared || ctxt.linkShared || ctxt.BuildMode == BuildModePlugin || ctxt.CanUsePlugins() return ctxt.BuildMode == BuildModeShared || ctxt.linkShared || ctxt.BuildMode == BuildModePlugin || ctxt.CanUsePlugins()
} }
// CanUsePlugins returns whether a plugins can be used // CanUsePlugins reports whether a plugins can be used
func (ctxt *Link) CanUsePlugins() bool { func (ctxt *Link) CanUsePlugins() bool {
return ctxt.Syms.ROLookup("plugin.Open", sym.SymVerABIInternal) != nil return ctxt.Syms.ROLookup("plugin.Open", sym.SymVerABIInternal) != nil
} }
// UseRelro returns whether to make use of "read only relocations" aka // UseRelro reports whether to make use of "read only relocations" aka
// relro. // relro.
func (ctxt *Link) UseRelro() bool { func (ctxt *Link) UseRelro() bool {
switch ctxt.BuildMode { switch ctxt.BuildMode {

View file

@ -101,7 +101,7 @@ func colorize(msg string) string {
return colorEscape + msg + colorResetEscape return colorEscape + msg + colorResetEscape
} }
// IsTerminal returns whether the UI is known to be tied to an // IsTerminal reports whether the UI is known to be tied to an
// interactive terminal (as opposed to being redirected to a file). // interactive terminal (as opposed to being redirected to a file).
func (r *readlineUI) IsTerminal() bool { func (r *readlineUI) IsTerminal() bool {
const stdout = 1 const stdout = 1

View file

@ -538,7 +538,7 @@ func (task *taskDesc) overlappingInstant(ev *trace.Event) bool {
return false return false
} }
// overlappingDuration returns whether the durational event, ev, overlaps with // overlappingDuration reports whether the durational event, ev, overlaps with
// any of the task's region if ev is a goroutine-local event, or overlaps with // any of the task's region if ev is a goroutine-local event, or overlaps with
// the task's lifetime if ev is a global event. It returns the overlapping time // the task's lifetime if ev is a global event. It returns the overlapping time
// as well. // as well.

View file

@ -240,7 +240,7 @@ const (
RequireAndVerifyClientCert RequireAndVerifyClientCert
) )
// requiresClientCert returns whether the ClientAuthType requires a client // requiresClientCert reports whether the ClientAuthType requires a client
// certificate to be provided. // certificate to be provided.
func requiresClientCert(c ClientAuthType) bool { func requiresClientCert(c ClientAuthType) bool {
switch c { switch c {

View file

@ -464,7 +464,7 @@ func (hs *serverHandshakeStateTLS13) doHelloRetryRequest(selectedGroup CurveID)
return nil return nil
} }
// illegalClientHelloChange returns whether the two ClientHello messages are // illegalClientHelloChange reports whether the two ClientHello messages are
// different, with the exception of the changes allowed before and after a // different, with the exception of the changes allowed before and after a
// HelloRetryRequest. See RFC 8446, Section 4.1.2. // HelloRetryRequest. See RFC 8446, Section 4.1.2.
func illegalClientHelloChange(ch, ch1 *clientHelloMsg) bool { func illegalClientHelloChange(ch, ch1 *clientHelloMsg) bool {

View file

@ -227,7 +227,7 @@ func (n Name) String() string {
return n.ToRDNSequence().String() return n.ToRDNSequence().String()
} }
// oidInAttributeTypeAndValue returns whether a type with the given OID exists // oidInAttributeTypeAndValue reports whether a type with the given OID exists
// in atv. // in atv.
func oidInAttributeTypeAndValue(oid asn1.ObjectIdentifier, atv []AttributeTypeAndValue) bool { func oidInAttributeTypeAndValue(oid asn1.ObjectIdentifier, atv []AttributeTypeAndValue) bool {
for _, a := range atv { for _, a := range atv {

View file

@ -858,7 +858,7 @@ nextIntermediate:
return return
} }
// validHostname returns whether host is a valid hostname that can be matched or // validHostname reports whether host is a valid hostname that can be matched or
// matched against according to RFC 6125 2.2, with some leniency to accommodate // matched against according to RFC 6125 2.2, with some leniency to accommodate
// legacy values. // legacy values.
func validHostname(host string) bool { func validHostname(host string) bool {

View file

@ -1641,7 +1641,7 @@ var (
oidAuthorityInfoAccessIssuers = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 48, 2} oidAuthorityInfoAccessIssuers = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 48, 2}
) )
// oidNotInExtensions returns whether an extension with the given oid exists in // oidNotInExtensions reports whether an extension with the given oid exists in
// extensions. // extensions.
func oidInExtensions(oid asn1.ObjectIdentifier, extensions []pkix.Extension) bool { func oidInExtensions(oid asn1.ObjectIdentifier, extensions []pkix.Extension) bool {
for _, e := range extensions { for _, e := range extensions {

View file

@ -2821,7 +2821,7 @@ func (ci *ColumnType) ScanType() reflect.Type {
return ci.scanType return ci.scanType
} }
// Nullable returns whether the column may be null. // Nullable reports whether the column may be null.
// If a driver does not support this property ok will be false. // If a driver does not support this property ok will be false.
func (ci *ColumnType) Nullable() (nullable, ok bool) { func (ci *ColumnType) Nullable() (nullable, ok bool) {
return ci.nullable, ci.hasNullable return ci.nullable, ci.hasNullable

View file

@ -590,7 +590,7 @@ func (r *LineReader) SeekPC(pc uint64, entry *LineEntry) error {
} }
} }
// pathIsAbs returns whether path is an absolute path (or "full path // pathIsAbs reports whether path is an absolute path (or "full path
// name" in DWARF parlance). This is in "whatever form makes sense for // name" in DWARF parlance). This is in "whatever form makes sense for
// the host system", so this accepts both UNIX-style and DOS-style // the host system", so this accepts both UNIX-style and DOS-style
// absolute paths. We avoid the filepath package because we want this // absolute paths. We avoid the filepath package because we want this

View file

@ -976,7 +976,7 @@ func (p *printer) possibleSelectorExpr(expr ast.Expr, prec1, depth int) bool {
return false return false
} }
// selectorExpr handles an *ast.SelectorExpr node and returns whether x spans // selectorExpr handles an *ast.SelectorExpr node and reports whether x spans
// multiple lines. // multiple lines.
func (p *printer) selectorExpr(x *ast.SelectorExpr, depth int, isMethod bool) bool { func (p *printer) selectorExpr(x *ast.SelectorExpr, depth int, isMethod bool) bool {
p.expr1(x.X, token.HighestPrec, depth) p.expr1(x.X, token.HighestPrec, depth)

View file

@ -14,7 +14,7 @@ import (
"sync" "sync"
) )
// IsStandardPackage returns whether path is a standard package, // IsStandardPackage reports whether path is a standard package,
// given goroot and compiler. // given goroot and compiler.
func IsStandardPackage(goroot, compiler, path string) bool { func IsStandardPackage(goroot, compiler, path string) bool {
switch compiler { switch compiler {
@ -95,7 +95,7 @@ func (gd *gccgoDirs) init() {
gd.dirs = append(gd.dirs, lastDirs...) gd.dirs = append(gd.dirs, lastDirs...)
} }
// isStandard returns whether path is a standard library for gccgo. // isStandard reports whether path is a standard library for gccgo.
func (gd *gccgoDirs) isStandard(path string) bool { func (gd *gccgoDirs) isStandard(path string) bool {
// Quick check: if the first path component has a '.', it's not // Quick check: if the first path component has a '.', it's not
// in the standard library. This skips most GOPATH directories. // in the standard library. This skips most GOPATH directories.

View file

@ -11,7 +11,7 @@ import (
"path/filepath" "path/filepath"
) )
// IsStandardPackage returns whether path is a standard package, // IsStandardPackage reports whether path is a standard package,
// given goroot and compiler. // given goroot and compiler.
func IsStandardPackage(goroot, compiler, path string) bool { func IsStandardPackage(goroot, compiler, path string) bool {
switch compiler { switch compiler {

View file

@ -263,7 +263,7 @@ func readCookies(h Header, filter string) []*Cookie {
return cookies return cookies
} }
// validCookieDomain returns whether v is a valid cookie domain-value. // validCookieDomain reports whether v is a valid cookie domain-value.
func validCookieDomain(v string) bool { func validCookieDomain(v string) bool {
if isCookieDomainName(v) { if isCookieDomainName(v) {
return true return true
@ -274,13 +274,13 @@ func validCookieDomain(v string) bool {
return false return false
} }
// validCookieExpires returns whether v is a valid cookie expires-value. // validCookieExpires reports whether v is a valid cookie expires-value.
func validCookieExpires(t time.Time) bool { func validCookieExpires(t time.Time) bool {
// IETF RFC 6265 Section 5.1.1.5, the year must not be less than 1601 // IETF RFC 6265 Section 5.1.1.5, the year must not be less than 1601
return t.Year() >= 1601 return t.Year() >= 1601
} }
// isCookieDomainName returns whether s is a valid domain name or a valid // isCookieDomainName reports whether s is a valid domain name or a valid
// domain name with a leading dot '.'. It is almost a direct copy of // domain name with a leading dot '.'. It is almost a direct copy of
// package net's isDomainName. // package net's isDomainName.
func isCookieDomainName(s string) bool { func isCookieDomainName(s string) bool {

View file

@ -4852,7 +4852,7 @@ func (sc *http2serverConn) resetStream(se http2StreamError) {
// processFrameFromReader processes the serve loop's read from readFrameCh from the // processFrameFromReader processes the serve loop's read from readFrameCh from the
// frame-reading goroutine. // frame-reading goroutine.
// processFrameFromReader returns whether the connection should be kept open. // processFrameFromReader reports whether the connection should be kept open.
func (sc *http2serverConn) processFrameFromReader(res http2readFrameResult) bool { func (sc *http2serverConn) processFrameFromReader(res http2readFrameResult) bool {
sc.serveG.check() sc.serveG.check()
err := res.err err := res.err

View file

@ -3082,7 +3082,7 @@ func (srv *Server) ListenAndServeTLS(certFile, keyFile string) error {
} }
// setupHTTP2_ServeTLS conditionally configures HTTP/2 on // setupHTTP2_ServeTLS conditionally configures HTTP/2 on
// srv and returns whether there was an error setting it up. If it is // srv and reports whether there was an error setting it up. If it is
// not configured for policy reasons, nil is returned. // not configured for policy reasons, nil is returned.
func (srv *Server) setupHTTP2_ServeTLS() error { func (srv *Server) setupHTTP2_ServeTLS() error {
srv.nextProtoOnce.Do(srv.onceSetNextProtoDefaults) srv.nextProtoOnce.Do(srv.onceSetNextProtoDefaults)

View file

@ -188,7 +188,7 @@ var zoneCache = ipv6ZoneCache{
} }
// update refreshes the network interface information if the cache was last // update refreshes the network interface information if the cache was last
// updated more than 1 minute ago, or if force is set. It returns whether the // updated more than 1 minute ago, or if force is set. It reports whether the
// cache was updated. // cache was updated.
func (zc *ipv6ZoneCache) update(ift []Interface, force bool) (updated bool) { func (zc *ipv6ZoneCache) update(ift []Interface, force bool) (updated bool) {
zc.Lock() zc.Lock()

View file

@ -7,7 +7,7 @@
package os package os
// blockUntilWaitable attempts to block until a call to p.Wait will // blockUntilWaitable attempts to block until a call to p.Wait will
// succeed immediately, and returns whether it has done so. // succeed immediately, and reports whether it has done so.
// It does not actually call p.Wait. // It does not actually call p.Wait.
// This version is used on systems that do not implement waitid, // This version is used on systems that do not implement waitid,
// or where we have not implemented it yet. // or where we have not implemented it yet.

View file

@ -14,7 +14,7 @@ import (
const _P_PID = 0 const _P_PID = 0
// blockUntilWaitable attempts to block until a call to p.Wait will // blockUntilWaitable attempts to block until a call to p.Wait will
// succeed immediately, and returns whether it has done so. // succeed immediately, and reports whether it has done so.
// It does not actually call p.Wait. // It does not actually call p.Wait.
func (p *Process) blockUntilWaitable() (bool, error) { func (p *Process) blockUntilWaitable() (bool, error) {
var errno syscall.Errno var errno syscall.Errno

View file

@ -18,7 +18,7 @@ import (
const _P_PID = 1 const _P_PID = 1
// blockUntilWaitable attempts to block until a call to p.Wait will // blockUntilWaitable attempts to block until a call to p.Wait will
// succeed immediately, and returns whether it has done so. // succeed immediately, and reports whether it has done so.
// It does not actually call p.Wait. // It does not actually call p.Wait.
func (p *Process) blockUntilWaitable() (bool, error) { func (p *Process) blockUntilWaitable() (bool, error) {
// The waitid system call expects a pointer to a siginfo_t, // The waitid system call expects a pointer to a siginfo_t,

View file

@ -43,7 +43,7 @@ func normBase(path string) (string, error) {
return syscall.UTF16ToString(data.FileName[:]), nil return syscall.UTF16ToString(data.FileName[:]), nil
} }
// baseIsDotDot returns whether the last element of path is "..". // baseIsDotDot reports whether the last element of path is "..".
// The given path should be 'Clean'-ed in advance. // The given path should be 'Clean'-ed in advance.
func baseIsDotDot(path string) bool { func baseIsDotDot(path string) bool {
i := strings.LastIndexByte(path, Separator) i := strings.LastIndexByte(path, Separator)

View file

@ -606,7 +606,7 @@ func cgoCheckUnknownPointer(p unsafe.Pointer, msg string) (base, i uintptr) {
return return
} }
// cgoIsGoPointer returns whether the pointer is a Go pointer--a // cgoIsGoPointer reports whether the pointer is a Go pointer--a
// pointer to Go memory. We only care about Go memory that might // pointer to Go memory. We only care about Go memory that might
// contain pointers. // contain pointers.
//go:nosplit //go:nosplit
@ -629,7 +629,7 @@ func cgoIsGoPointer(p unsafe.Pointer) bool {
return false return false
} }
// cgoInRange returns whether p is between start and end. // cgoInRange reports whether p is between start and end.
//go:nosplit //go:nosplit
//go:nowritebarrierrec //go:nowritebarrierrec
func cgoInRange(p unsafe.Pointer, start, end uintptr) bool { func cgoInRange(p unsafe.Pointer, start, end uintptr) bool {

View file

@ -242,7 +242,7 @@ func (s *mspan) nextFreeIndex() uintptr {
return result return result
} }
// isFree returns whether the index'th object in s is unallocated. // isFree reports whether the index'th object in s is unallocated.
func (s *mspan) isFree(index uintptr) bool { func (s *mspan) isFree(index uintptr) bool {
if index < s.freeindex { if index < s.freeindex {
return false return false

View file

@ -558,7 +558,7 @@ func gcWakeAllAssists() {
// gcParkAssist puts the current goroutine on the assist queue and parks. // gcParkAssist puts the current goroutine on the assist queue and parks.
// //
// gcParkAssist returns whether the assist is now satisfied. If it // gcParkAssist reports whether the assist is now satisfied. If it
// returns false, the caller must retry the assist. // returns false, the caller must retry the assist.
// //
//go:nowritebarrier //go:nowritebarrier

View file

@ -55,7 +55,7 @@ func (p *Profile) FilterSamplesByName(focus, ignore, hide *regexp.Regexp) (fm, i
return return
} }
// matchesName returns whether the function name or file in the // matchesName reports whether the function name or file in the
// location matches the regular expression. // location matches the regular expression.
func (loc *Location) matchesName(re *regexp.Regexp) bool { func (loc *Location) matchesName(re *regexp.Regexp) bool {
for _, ln := range loc.Line { for _, ln := range loc.Line {

View file

@ -4592,7 +4592,7 @@ func schedEnableUser(enable bool) {
} }
} }
// schedEnabled returns whether gp should be scheduled. It returns // schedEnabled reports whether gp should be scheduled. It returns
// false is scheduling of gp is disabled. // false is scheduling of gp is disabled.
func schedEnabled(gp *g) bool { func schedEnabled(gp *g) bool {
if sched.disable.user { if sched.disable.user {

View file

@ -110,7 +110,7 @@ func block() {
// //
// selectgo returns the index of the chosen scase, which matches the // selectgo returns the index of the chosen scase, which matches the
// ordinal position of its respective select{recv,send,default} call. // ordinal position of its respective select{recv,send,default} call.
// Also, if the chosen scase was a receive operation, it returns whether // Also, if the chosen scase was a receive operation, it reports whether
// a value was received. // a value was received.
func selectgo(cas0 *scase, order0 *uint16, ncases int) (int, bool) { func selectgo(cas0 *scase, order0 *uint16, ncases int) (int, bool) {
if debugSelect { if debugSelect {

View file

@ -773,7 +773,7 @@ func unminitSignals() {
} }
} }
// blockableSig returns whether sig may be blocked by the signal mask. // blockableSig reports whether sig may be blocked by the signal mask.
// We never want to block the signals marked _SigUnblock; // We never want to block the signals marked _SigUnblock;
// these are the synchronous signals that turn into a Go panic. // these are the synchronous signals that turn into a Go panic.
// In a Go program--not a c-archive/c-shared--we never want to block // In a Go program--not a c-archive/c-shared--we never want to block

View file

@ -298,7 +298,7 @@ func round(n, a uintptr) uintptr {
return (n + a - 1) &^ (a - 1) return (n + a - 1) &^ (a - 1)
} }
// checkASM returns whether assembly runtime checks have passed. // checkASM reports whether assembly runtime checks have passed.
func checkASM() bool func checkASM() bool
func memequal_varlen(a, b unsafe.Pointer) bool func memequal_varlen(a, b unsafe.Pointer) bool

View file

@ -171,7 +171,7 @@ func (r *Region) End() {
userRegion(r.id, regionEndCode, r.regionType) userRegion(r.id, regionEndCode, r.regionType)
} }
// IsEnabled returns whether tracing is enabled. // IsEnabled reports whether tracing is enabled.
// The information is advisory only. The tracing status // The information is advisory only. The tracing status
// may have changed by the time this function returns. // may have changed by the time this function returns.
func IsEnabled() bool { func IsEnabled() bool {

View file

@ -876,7 +876,7 @@ func isExportedRuntime(name string) bool {
return len(name) > n && name[:n] == "runtime." && 'A' <= name[n] && name[n] <= 'Z' return len(name) > n && name[:n] == "runtime." && 'A' <= name[n] && name[n] <= 'Z'
} }
// elideWrapperCalling returns whether a wrapper function that called // elideWrapperCalling reports whether a wrapper function that called
// function "name" should be elided from stack traces. // function "name" should be elided from stack traces.
func elideWrapperCalling(name string) bool { func elideWrapperCalling(name string) bool {
// If the wrapper called a panic function instead of the // If the wrapper called a panic function instead of the

View file

@ -280,7 +280,7 @@ func vdsoauxv(tag, val uintptr) {
} }
} }
// vdsoMarker returns whether PC is on the VDSO page. // vdsoMarker reports whether PC is on the VDSO page.
func inVDSOPage(pc uintptr) bool { func inVDSOPage(pc uintptr) bool {
for _, k := range vdsoSymbolKeys { for _, k := range vdsoSymbolKeys {
if *k.ptr != 0 { if *k.ptr != 0 {

View file

@ -230,7 +230,7 @@ func roundUp(n int) int {
} }
} }
// run1 runs the first iteration of benchFunc. It returns whether more // run1 runs the first iteration of benchFunc. It reports whether more
// iterations of this benchmarks should be run. // iterations of this benchmarks should be run.
func (b *B) run1() bool { func (b *B) run1() bool {
if ctx := b.context; ctx != nil { if ctx := b.context; ctx != nil {

View file

@ -205,7 +205,7 @@ func (l *Location) lookupFirstZone() int {
return 0 return 0
} }
// firstZoneUsed returns whether the first zone is used by some // firstZoneUsed reports whether the first zone is used by some
// transition. // transition.
func (l *Location) firstZoneUsed() bool { func (l *Location) firstZoneUsed() bool {
for _, tx := range l.tx { for _, tx := range l.tx {