Document graceful shutdown needed for external coverage collection #458
Conversation
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
1 participant
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.
This adds a short note to the README under "Get coverage of external tests" explaining that externally-run, long-running servers must shut down cleanly so LLVM's coverage runtime can flush profiling data. It includes a small example.
Potential follow-ups:
A help-note could be added to the runsubcommand help. That depends on feedback, so omitted for now.
It’s possible the run subcommand’s assumptions make embedding this guidance there undesirable — that, and that a help text didnt really seem to fix, was why it was left out.
There also might be a cleaner or more idiomatic shutdown pattern you prefer.
Note that this documentation was generated by an LLM based on my input.