Page MenuHome

Cleanup: Remove txt guide and expand code docs (MEM_guardedalloc)
Needs ReviewPublic

Authored by Aaron Carlisle (Blendify) on Aug 31 2020, 10:50 PM.

Details

Summary

This removes the outdated txt guide for MEM_guardedalloc in favor of keeping the docs with the code.

I did not port over the text stating the ANSI alloc equivalents, if the information is useful I can port this over to the doxygen comments.

Diff Detail

Event Timeline

Aaron Carlisle (Blendify) requested review of this revision.Aug 31 2020, 10:50 PM
Aaron Carlisle (Blendify) created this revision.

The description is outdated and should not go into implementation details, I would rewrite it to something like this.

Memory allocation in Blender uses its own set of functions to detect memory leaks and out-of-bound writes. By default, only simply leak detection is enabled. When running with --debug-memory, more information about leaks and detection of out-of-bounds writes is enabled.

Removing blender-guardedalloc.txt seems fine, that information can be found in MEM_guardedalloc.h.

Update About the MEM module section with feedback