doc: ZSTD_free*() functions accept NULL pointer#2521
Conversation
terrelln
approved these changes
Mar 4, 2021
Cyan4973
approved these changes
Mar 4, 2021
Merged
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.
ZSTD_free*()functions acceptNULLpointer, it would be nice to state in doc.I generated HTML doc with
gen_htmltool and checked them.Related code for review:
ZSTD_freeCCtx
https://github.com/facebook/zstd/blob/v1.4.9/lib/compress/zstd_compress.c#L161-L163
ZSTD_freeDCtx
https://github.com/facebook/zstd/blob/v1.4.9/lib/decompress/zstd_decompress.c#L310-L312
ZSTD_freeCStream
https://github.com/facebook/zstd/blob/v1.4.9/lib/compress/zstd_compress.c#L4045-L4048
ZSTD_freeDStream
https://github.com/facebook/zstd/blob/v1.4.9/lib/decompress/zstd_decompress.c#L1510-L1513
ZSTD_freeCDict
https://github.com/facebook/zstd/blob/v1.4.9/lib/compress/zstd_compress.c#L3866-L3868
ZSTD_freeDDict
https://github.com/facebook/zstd/blob/v1.4.9/lib/decompress/zstd_ddict.c#L212-L214
ZSTD_freeThreadPool
https://github.com/facebook/zstd/blob/v1.4.9/lib/common/pool.c#L180-L193
ZSTD_freeCCtxParams
https://github.com/facebook/zstd/blob/v1.4.9/lib/compress/zstd_compress.c#L253-L255