Skip to content

cmd/go: clarify test cache behavior for file metadata - #82377

Open
FawwazLawal wants to merge 1 commit into
golang:masterfrom
FawwazLawal:docs/35301-go-help-test-cache-wording
Open

FawwazLawal wants to merge 1 commit into
golang:masterfrom
FawwazLawal:docs/35301-go-help-test-cache-wording

Conversation

@FawwazLawal

Copy link
Copy Markdown

The help text for go test -run says that for test inputs that
are files, the test result cache checks content. In practice,
the cache checks file metadata such as modification time and
size, not content (see hashWriteStat in
src/cmd/go/internal/cache/hash.go). This wording has been a
recurring source of confusion.

Update the help text in test.go and regenerate alldocs.go to
say "file metadata such as modification time and size" instead
of "content".

I noticed the discrepancy while working through the test caching
behavior described in #35301. My earlier repro comment
(#35301 (comment))
shows the practical effect: modifying a testdata file without
changing its mtime does not invalidate the cache. This is the
expected behavior given hashWriteStat, but the help text implies
otherwise.

Updates #35301

The help text for go test -run says that for test inputs that are
files, the test result cache checks content. In practice, the cache
checks file metadata such as modification time and size, not content.
This wording has been a recurring source of confusion (see golang#35301).

Update the help text in test.go and regenerate alldocs.go.

Updates golang#35301
@gopherbot

Copy link
Copy Markdown
Contributor

This PR (HEAD: 9ea20b6) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/851825.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot

Copy link
Copy Markdown
Contributor

Message from Gopher Robot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
A maintainer will review your change and provide feedback. See
https://go.dev/doc/contribute#review for more info and tips to get your
patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11 or adds a tag like "wait-release", it means that this CL will be
reviewed as part of the next development cycle. See https://go.dev/s/release
for more details.


Please don’t reply on this GitHub thread. Visit golang.org/cl/851825.
After addressing review feedback, remember to publish your drafts!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants