Navigation Menu

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: document -test.benchmem and ReportAllocs output format #42239

Open
ianlancetaylor opened this issue Oct 28, 2020 · 1 comment
Open
Labels
Documentation help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@ianlancetaylor
Copy link
Contributor

Filing this bug on behalf of someone who prefers not to do it directly:

The ⁠(*testing.B).ReportAllocs function's documentation says that its output is the same as setting -test.benchmem. However, there is as far as I can tell no explanation anywhere of what, exactly, -test.benchmem is or what it does. There is also no explanation as to what the output format is. For instance, in an output line like

BenchmarkF-34         	    9718	    672043 ns/op	   34474 B/op	     508 allocs/op

I can see the lines with four numbers, but one of them is completely dimensionless and the others aren't entirely clear.

@ianlancetaylor ianlancetaylor added Documentation help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Oct 28, 2020
@ianlancetaylor ianlancetaylor added this to the Backlog milestone Oct 28, 2020
@gopherbot
Copy link

Change https://golang.org/cl/266917 mentions this issue: testing: document -benchmem flag output format

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

2 participants