docs: Add headless test instructions + reshuffle build doc format#2374
Open
cswilson252 wants to merge 2 commits intoPhotonVision:mainfrom
Open
docs: Add headless test instructions + reshuffle build doc format#2374cswilson252 wants to merge 2 commits intoPhotonVision:mainfrom
cswilson252 wants to merge 2 commits intoPhotonVision:mainfrom
Conversation
github-actions
bot
added
the
documentation
Gold856
requested changes
Feb 24, 2026
mcm001
reviewed
Feb 24, 2026
| ``` | ||
|
|
||
| To correctly run PhotonVision tests this way, you must [delegate the tests to Gradle](https://code.visualstudio.com/docs/java/java-build#_delegate-tests-to-gradle). Debugging tests like this will [**not** currently](https://github.com/microsoft/build-server-for-gradle/issues/119) collect outputs. | ||
| Stop any existing instance of PhotonVision. |
| Stop any existing instance of PhotonVision. | ||
|
|
||
| ### Running Tests With UI | ||
| Launch the program with the following additional argument to the JVM: {code}`java -jar -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5801 photonvision.jar` |
Contributor
There was a problem hiding this comment.
This command says suspended, no, but the text seems to imply that suspended is enabled
mcm001
reviewed
Feb 24, 2026
|
|
||
| ## Running Tests | ||
|
|
||
| ### Running Headless Tests |
Contributor
There was a problem hiding this comment.
I wonder if calling these headless is going to be confusing since everyone else does not mention this. I feel like whether or not the test is headless or not is maybe outside of the scope of the section? People care about running a particular test, and GUI Windows being hidden by default is maybe just an implementation detail
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #1902
What changed? Why? (the code + comments should speak for itself on the "how")
The amount of UI windows that contributors have open (and then proceed to frantically close) increases exponentially with every passing build season (Munroe 2009).
This PR adds headless (no-UI) test instructions, moves all of the test related build documentation to its own subsection (and reorders it roughly in the order we prefer they be used in), and makes the "Example" sections their own independent H2.
Meta
Merge checklist: