Skip to content

cmd/go/internal/test: Documentation about "package's source root" is imprecise. #64303

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.

Sign up for GitHub

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
Closed
your-diary opened this issue Nov 21, 2023 · 4 comments
Closed

cmd/go/internal/test: Documentation about "package's source root" is imprecise. #64303

your-diary opened this issue Nov 21, 2023 · 4 comments
Labels
Documentation Issues describing a change to documentation. FixPending Issues that have a fix which has not yet been reviewed or submitted. GoCommand cmd/go help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.24

Comments

@your-diary
Copy link 

$ go version
1.21.4

In the documentation of test package, it is said

Tests that open files within the package's source root (usually $GOPATH) or that consult environment variables only match future runs in which the files and environment variables are unchanged.

However, is "the package's source root" really usually $GOPATH (e.g. ~/go)?
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Nov 21, 2023
@mknyszek mknyszek added this to the Backlog milestone Nov 21, 2023
@mknyszek mknyszek added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Nov 21, 2023
@mknyszek
Copy link
Contributor

AFAICT this is internal documentation, so it's not really intended to be user-facing. I think this question is more appropriate for the golang-dev mailing list.

That being said, I'm not sure what the right thing here is. CC @bcmills

Closing this issue for now. Thanks for flagging this.

@mknyszek mknyszek closed this as not planned Won't fix, can't repro, duplicate, stale Nov 21, 2023
@bcmills
Copy link
Contributor

bcmills commented Nov 21, 2023

I think this issue is about the string displayed by go help test, not the package doc comment.

@bcmills bcmills reopened this Nov 21, 2023
@bcmills
Copy link
Contributor

bcmills commented Nov 21, 2023

@your-diary, these days the package's source root is usually the module that contains it. (The comment is out of date.)

@bcmills bcmills added NeedsFix The path to resolution is known, but the work has not been done. help wanted GoCommand cmd/go labels Nov 21, 2023
@gopherbot gopherbot removed the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Nov 21, 2023
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/598235 mentions this issue: cmd/go/internal/test: update documentation for the "go test" command

@dmitshur dmitshur modified the milestones: Backlog, Go1.24 Jul 25, 2024
@dmitshur dmitshur added the FixPending Issues that have a fix which has not yet been reviewed or submitted. label Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FixPending Issues that have a fix which has not yet been reviewed or submitted. GoCommand cmd/go help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.24
Development

No branches or pull requests
5 participants
@mknyszek @dmitshur @bcmills @gopherbot @your-diary