1
0
mirror of https://github.com/golang/go synced 2024-11-19 03:44:40 -07:00

testing: document that flag.Parse is not called when TestMain runs

Fixes #9825.

Change-Id: Id7eeaa14c26201db34db0820371c92a63af485b0
Reviewed-on: https://go-review.googlesource.com/7604
Reviewed-by: Rob Pike <r@golang.org>
This commit is contained in:
Shenghou Ma 2015-03-15 21:08:57 -04:00 committed by Minux Ma
parent 20b3a9b6ed
commit f63678ae91

View File

@ -130,13 +130,17 @@
// then the generated test will call TestMain(m) instead of running the tests
// directly. TestMain runs in the main goroutine and can do whatever setup
// and teardown is necessary around a call to m.Run. It should then call
// os.Exit with the result of m.Run.
// os.Exit with the result of m.Run. When TestMain is called, flag.Parse has
// not been run. If TestMain depends on command-line flags, including those
// of the testing package, it should call flag.Parse explicitly.
//
// The minimal implementation of TestMain is:
// A simple implementation of TestMain is:
//
// func TestMain(m *testing.M) { os.Exit(m.Run()) }
// func TestMain(m *testing.M) {
// flag.Parse()
// os.Exit(m.Run())
// }
//
// In effect, that is the implementation used when no TestMain is explicitly defined.
package testing
import (