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.

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

Expand on docstring of GC.safepoint #57128

Merged
merged 2 commits into from
Jan 23, 2025
Merged

Conversation

jakobnissen
Copy link
Contributor

Update the docstring to mention the following points:

  • Safepoints are very fast, but may still degrade performance in tight loops
  • Safepoints do not trigger the GC, but instead stops a task from blocking GC that would otherwise run.
  • Switch terminology from mentioning 'threads' to 'tasks'

Update the docstring to mention the following points:
* Safepoints are very fast, but may still degrade performance in tight loops
* Safepoints do not trigger the GC, but instead stops a task from blocking
  GC that would otherwise run.
* Switch terminology from mentioning 'threads' to 'tasks'
@jakobnissen jakobnissen added the docs This change adds or pertains to documentation label Jan 22, 2025
base/gcutils.jl Outdated Show resolved Hide resolved
base/gcutils.jl Outdated Show resolved Hide resolved
@d-netto d-netto added the GC Garbage collector label Jan 22, 2025
Copy link
Member

@d-netto d-netto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@d-netto d-netto merged commit f52c4ab into JuliaLang:master Jan 23, 2025
7 checks passed
@jakobnissen jakobnissen deleted the safepoint branch January 23, 2025 11:14
xal-0 pushed a commit to xal-0/julia that referenced this pull request Jan 24, 2025
Update the docstring to mention the following points:
* Safepoints are very fast, but may still degrade performance in tight
loops
* Safepoints do not trigger the GC, but instead stops a task from
blocking GC that would otherwise run.
* Switch terminology from mentioning 'threads' to 'tasks'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation GC Garbage collector
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants