Repository navigation
Docs: document cJSON_Version non-reentrant return value - #1138
Open
YikunWei-dev wants to merge 1 commit into
Open
YikunWei-dev wants to merge 1 commit into
YikunWei-dev wants to merge 1 commit into
Conversation
cJSON_Version() returns a pointer to a static internal buffer that is overwritten on every call, so the returned pointer is only valid until the next call and must not be shared between threads. This was not documented anywhere (the existing Thread Safety section only covered cJSON_GetErrorPtr, cJSON_InitHooks and setlocale). Add a note to the cJSON_Version declaration in cJSON.h, extend the "Thread Safety" section in README.md, and add a regression test in tests/misc_tests.c that captures the reused-buffer contract.
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
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.
cJSON_Version() returns a pointer to a static internal buffer that is overwritten on every call, so the returned pointer is only valid until the next call and must not be shared between threads. This was not documented anywhere (the existing Thread Safety section only covered cJSON_GetErrorPtr, cJSON_InitHooks and setlocale).
Add a note to the cJSON_Version declaration in cJSON.h, extend the "Thread Safety" section in README.md, and add a regression test in tests/misc_tests.c that captures the reused-buffer contract.