Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

testing: B logs are printed on stdout, but doc says they go to stderr #36257

Closed
megalepozy opened this issue Dec 23, 2019 · 2 comments
Closed
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@megalepozy
Copy link

What version of Go are you using (go version)?

$ go version
go version go1.13 linux/amd64

Does this issue reproduce with the latest release?

It's an issue at the documentation so the question is irrelavent

What operating system and processor architecture are you using (go env)?

go env Output
$ go env
GO111MODULE=""
GOARCH="amd64"
GOBIN=""
GOCACHE="/home/nimrod/.cache/go-build"
GOENV="/home/nimrod/.config/go/env"
GOEXE=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GONOPROXY=""
GONOSUMDB=""
GOOS="linux"
GOPATH="/home/nimrod/go"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/usr/local/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/usr/local/go/pkg/tool/linux_amd64"
GCCGO="gccgo"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD=""
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build403478965=/tmp/go-build -gno-record-gcc-switches"

What did you do?

Read the testing pkg documentation and saw that its incorrect at https://golang.org/pkg/testing/#B

What did you expect to see?

"Like in tests, benchmark logs are accumulated during execution and dumped to standard output when done."

What did you see instead?

The following is a quote from the third paragraph on Type B:
"Like in tests, benchmark logs are accumulated during execution and dumped to standard error when done."

It's incorrect as it state that the benchmark logs are dumped to standard error

@gopherbot gopherbot added this to the Unreleased milestone Dec 23, 2019
@ALTree
Copy link
Member

ALTree commented Dec 23, 2019

Thanks for reporting this.

Apparently the testing.T documentation had the same issue, but it was fixed in CL 24311. I will send a CL to fix testing.B too.

@gopherbot
Copy link

Change https://golang.org/cl/212457 mentions this issue: testing: document that benchmark logs are dumped to stdout

@ALTree ALTree changed the title x/website: testing package (type B) incorrect documentation testing: B logs are printed on stdout, but doc says they go to stderr Dec 23, 2019
@ALTree ALTree added the NeedsFix The path to resolution is known, but the work has not been done. label Dec 23, 2019
@ALTree ALTree modified the milestones: Unreleased, Go1.14 Dec 23, 2019
@golang golang locked and limited conversation to collaborators Dec 22, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

3 participants