Improve documentation of sv_dup and sv_dup_inc #23454
Merged
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 is a follow-up on #22291
This reverts marking these functions as core-only. They really need to be API because it's often impossible to write thread-safe XS modules without them.
I've added an explanation of when exactly you need these functions, without that it's rather unclear when you'd need them (and when not).
This also clarifies that the pointer table is in fact not a cache, but an essential element of the cloning process. Without it, an non-incremented
sv_dup
wouldn't even make sense (something else would need to dup and increment it).I haven't touched the last paragraph because that needs #23325 to be resolved first.