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

Jump to bottom

cmd/go: go help testflag is poorly formatted for the -shuffle flag #49357

Closed
sfllaw opened this issue Nov 4, 2021 · 3 comments
Closed

cmd/go: go help testflag is poorly formatted for the -shuffle flag #49357

sfllaw opened this issue Nov 4, 2021 · 3 comments
Labels
Documentation FrozenDueToAge GoCommand cmd/go NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.18

Comments

@sfllaw
Copy link
Contributor

sfllaw commented Nov 4, 2021 •
edited

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

$ go version
go version go1.17 linux/amd64

What did you do?

$ go help testflag
…
	-shuffle off,on,N
		Randomize the execution order of tests and benchmarks.
		It is off by default. If -shuffle is set to on, then it will seed
		the randomizer using the system clock. If -shuffle is set to an
		integer N, then N will be used as the seed value. In both cases,
		the seed will be reported for reproducibility.
…

What is the problem?

The following stanza of the help text is using a tab character instead of four spaces, unlike the rest of the help text:

go/src/cmd/go/internal/test/test.go

Lines 309 to 314 in 629ffeb

-shuffle off,on,N
Randomize the execution order of tests and benchmarks.
It is off by default. If -shuffle is set to on, then it will seed
the randomizer using the system clock. If -shuffle is set to an
integer N, then N will be used as the seed value. In both cases,
the seed will be reported for reproducibility.

@thanm thanm added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Nov 4, 2021
@thanm
Copy link
Contributor

thanm commented Nov 4, 2021

@bcmills @matloob

@gopherbot
Copy link

Change https://golang.org/cl/361395 mentions this issue: test: fix indentation for -shuffle help text

@seankhliao seankhliao added Documentation GoCommand cmd/go NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Nov 4, 2021
@bcmills bcmills added this to the Go1.18 milestone Nov 4, 2021
@tpaschalis
Copy link
Contributor

Oh, that was me 😅 Thank you @sfllaw for catching this and congratulations on merging your first CL!

@golang golang locked and limited conversation to collaborators Nov 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge GoCommand cmd/go NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.18
Development

No branches or pull requests
6 participants
@sfllaw @bcmills @gopherbot @seankhliao @thanm @tpaschalis