Add remark about _aligned_malloc and free #1778
Merged
Conversation
This file contains 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
The docs state that using "free" for a pointer returned by _aligned_malloc is illegal but only as an inline comment within the code sample. This isn't visible enough as most people (including me) tend to skip the code sample section. Such an oversight will lead to crashes that can sometimes be time consuming to debug. For this reason, this patch adds another note to the "Remarks" section.
Wordsmith the addition. Bring the doc closer to current standards, fix date, add description, Acrolinx fixes, add relevant links.
colin-home
approved these changes
Dec 11, 2019
There was a problem hiding this comment.
@petrutlucian94 Thanks, that addition is an excellent idea. I did some other editing here mostly because it will save me some time later in the publishing process.
colin-home
approved these changes
Dec 11, 2019
|
Of course, maybe I should have waited. I'll do the other clean-up later. Thanks again. |
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.
The docs state that using "free" for a pointer returned by
_aligned_malloc is illegal but only as an inline comment within the
code sample.
This isn't visible enough as most people (including me) tend to skip
the code sample section. Such an oversight will lead to crashes that
can sometimes be time consuming to debug.
For this reason, this patch adds another note to the "Remarks"
section.