andygrove opened a new pull request, #4238:
URL: https://github.com/apache/datafusion-comet/pull/4238
## Which issue does this PR close?
Closes #.
## Rationale for this change
The contributor guide's "Common Build and Test Pitfalls" section currently
recommends
`-DwildcardSuites=...` for running specific tests. In practice this leads to
two
recurring foot-guns:
1. The recommendation conflicts with the working invocation shown later in
the same
document (`-Dsuites=` with `-Dtest=none`), so contributors copy the wrong
pattern.
2. A common variant, `./mvnw test -Dsuites="..." -DwildcardSuites=""`,
silently runs
every suite in the project (the empty string is a substring of every
suite name)
and takes around an hour, instead of running the named suite.
The existing warning about `-pl spark` also understates the problem: `-pl`
resolves
sibling modules from `~/.m2/repository`, which not only causes stale-code
surprises
but cross-contaminates concurrent worktrees that share the same local Maven
repo.
## What changes are included in this PR?
Edits to `docs/source/contributor-guide/development.md`:
- Renamed and expanded the `-pl` pitfall to call out both stale-code and
cross-worktree corruption under concurrent builds.
- Replaced the misleading "Use `wildcardSuites`" subsection with a "Running a
Specific ScalaTest Suite" subsection that documents the correct minimal
invocation, explains why `-Dtest=none` is required, and adds an explicit
callout for the `-DwildcardSuites=""` pitfall.
- Cross-linked the later "Running Tests from command line" section to the new
pitfall callout so the two places stay in sync.
## How are these changes tested?
Documentation-only change, no test changes required.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
