Skip to content

Add remark about _aligned_malloc and free - #1778

Merged
Colin Robertson (colin-home) merged 4 commits into
MicrosoftDocs:masterfrom
petrutlucian94:aligned_malloc
Dec 11, 2019
Merged

Colin Robertson (colin-home) merged 4 commits into
MicrosoftDocs:masterfrom
petrutlucian94:aligned_malloc

Conversation

@petrutlucian94

Copy link
Copy Markdown
Contributor

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.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Lucian Petrut (@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
Colin Robertson (colin-home) merged commit 3b9ad9c into MicrosoftDocs:master Dec 11, 2019
@colin-home

Copy link
Copy Markdown
Contributor

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

Labels

aq-pr-triaged Tracking label for the PR review team do-not-merge review-team-triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants