diff --git a/cmd/cover/cover.go b/cmd/cover/cover.go index 3ff99850..272cf65f 100644 --- a/cmd/cover/cover.go +++ b/cmd/cover/cover.go @@ -2,20 +2,6 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -// Cover is a program for analyzing the coverage profiles generated by -// 'go test -coverprofile=cover.out'. -// -// Cover is also used by 'go test -cover' to rewrite the source code with -// annotations to track which parts of each function are executed. -// It operates on one Go source file at a time, computing approximate -// basic block information by studying the source. It is thus more portable -// than binary-rewriting coverage tools, but also a little less capable. -// For instance, it does not probe inside && and || expressions, and can -// be mildly confused by single statements with multiple function literals. -// -// For usage information, please see: -// go help testflag -// go tool cover -help package main import ( diff --git a/cmd/cover/doc.go b/cmd/cover/doc.go new file mode 100644 index 00000000..636d7e08 --- /dev/null +++ b/cmd/cover/doc.go @@ -0,0 +1,21 @@ +// Copyright 2013 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +/* +Cover is a program for analyzing the coverage profiles generated by +'go test -coverprofile=cover.out'. + +Cover is also used by 'go test -cover' to rewrite the source code with +annotations to track which parts of each function are executed. +It operates on one Go source file at a time, computing approximate +basic block information by studying the source. It is thus more portable +than binary-rewriting coverage tools, but also a little less capable. +For instance, it does not probe inside && and || expressions, and can +be mildly confused by single statements with multiple function literals. + +For usage information, please see: + go help testflag + go tool cover -help +*/ +package main