[arrayfire] 199/284: Adding documentation for AF_MEM_DEBUG

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to branch debian/experimental
in repository arrayfire.

commit d5f3bf13f7c687519ec4309392051b4d88f44a4b
Author: Pavan Yalamanchili <pavan at arrayfire.com>
Date:   Mon Jan 11 15:00:25 2016 -0500

    Adding documentation for AF_MEM_DEBUG
---
 docs/pages/configuring_arrayfire_environment.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/pages/configuring_arrayfire_environment.md b/docs/pages/configuring_arrayfire_environment.md
index 7e197e4..37327ac 100644
--- a/docs/pages/configuring_arrayfire_environment.md
+++ b/docs/pages/configuring_arrayfire_environment.md
@@ -97,3 +97,15 @@ detailed. This helps in locating the exact failure.
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 AF_PRINT_ERRORS=1 ./myprogram_opencl
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+AF_MEM_DEBUG (#af_mem_debug)
+-------------------------------------------------------------------------------
+
+When AF_MEM_DEBUG is set to 1 (or anything not equal to 0), the caching mechanism in the memory manager.
+The device buffers are allocated using native functions as needed and freed when going out of scope.
+
+When the environment variable is not set, it is treated to be non zero.
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+AF_MEM_DEBUG=1 ./myprogram
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/arrayfire.git