Stowage/go
2
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-12-08 06:10:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

testing: document that Log and Logf do not usually produce output

Browse source 
The text is printed only if the test fails or -test.v is set.
Document this behavior in the testing package and 'go help test'.
Also put a 'go install' into mkdoc.sh so I don't get tricked by the
process of updating the documentation ever again.

Fixes #5174.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/8118047
This commit is contained in:
Rob Pike 2013-04-01 15:17:00 -07:00
parent a23dd4fe4e
commit 144dd2b21c
4 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/cmd/go/doc.go
View file

@ -763,7 +763,8 @@ control the execution of any test:
If a test runs longer than t, panic. If a test runs longer than t, panic.
-v -v
Verbose output: log all tests as they are run. Verbose output: log all tests as they are run. Also print all
text from Log and Logf calls even if the test succeeds.
The test binary, called pkg.test where pkg is the name of the The test binary, called pkg.test where pkg is the name of the
directory containing the package sources, can be invoked directly directory containing the package sources, can be invoked directly

1
src/cmd/go/mkdoc.sh
View file

@ -3,6 +3,7 @@
# Use of this source code is governed by a BSD-style # Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file. # license that can be found in the LICENSE file.
go install # So the next line will produce updated documentation.
go help documentation > doc.go go help documentation > doc.go
gofmt -w doc.go gofmt -w doc.go

3
src/cmd/go/test.go
View file

@ -153,7 +153,8 @@ control the execution of any test:
If a test runs longer than t, panic. If a test runs longer than t, panic.
-v -v
Verbose output: log all tests as they are run. Verbose output: log all tests as they are run. Also print all
text from Log and Logf calls even if the test succeeds.
The test binary, called pkg.test where pkg is the name of the The test binary, called pkg.test where pkg is the name of the
directory containing the package sources, can be invoked directly directory containing the package sources, can be invoked directly

6
src/pkg/testing/testing.go
View file

@ -246,11 +246,13 @@ func (c *common) log(s string) {
} }
// Log formats its arguments using default formatting, analogous to Println, // Log formats its arguments using default formatting, analogous to Println,
// and records the text in the error log. // and records the text in the error log. The text will be printed only if
// the test fails or the -test.v flag is set.
func (c *common) Log(args ...interface{}) { c.log(fmt.Sprintln(args...)) } func (c *common) Log(args ...interface{}) { c.log(fmt.Sprintln(args...)) }
// Logf formats its arguments according to the format, analogous to Printf, // Logf formats its arguments according to the format, analogous to Printf,
// and records the text in the error log. // and records the text in the error log. The text will be printed only if
// the test fails or the -test.v flag is set.
func (c *common) Logf(format string, args ...interface{}) { c.log(fmt.Sprintf(format, args...)) } func (c *common) Logf(format string, args ...interface{}) { c.log(fmt.Sprintf(format, args...)) }
// Error is equivalent to Log followed by Fail. // Error is equivalent to Log followed by Fail.