Skip to content
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

Document more precisely what NO_COVERAGE does #12

Open
wilfwilson opened this issue Jan 28, 2022 · 0 comments
Open

Document more precisely what NO_COVERAGE does #12

wilfwilson opened this issue Jan 28, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@wilfwilson
Copy link
Contributor

wilfwilson commented Jan 28, 2022 •
edited
Loading

Currently:

NO_COVERAGE: Set to a non-empty string to suppress gathering coverage.

For people who already know what this means, I think this is probably clear enough. But for people who don't... such as me, I think this could be clearer.

Does it stop the profiling package from collecting coverage data on the GAP side of the package? Does it also stop the package's kernel module from having code coverage collected? If this variable is set, does gap-actions/process-coverage stop working, or at least redundant?

This issue was inspired by my confusion in gap-packages/profiling#94
@wilfwilson wilfwilson added the documentation Improvements or additions to documentation label Jan 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wilfwilson