summaryrefslogtreecommitdiff
path: root/doc/developer
diff options
context:
space:
mode:
authorDonald Sharp <sharpd@cumulusnetworks.com>2020-12-01 12:08:52 -0500
committerGitHub <noreply@github.com>2020-12-01 12:08:52 -0500
commit5c1a899432d4efdea247f584d45a84351ff77a3a (patch)
tree425a0bf51260ec02fa6b67a7dc70852eca268be7 /doc/developer
parent958c62b712c8138135664740de49d2b1cd2e871a (diff)
parentfdac05fd9ab9d7f09f750243d0f4a97b25d389a1 (diff)
Merge pull request #7632 from idryzhov/vtysh-memory-fixes
vtysh memory fixes
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/memtypes.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/developer/memtypes.rst b/doc/developer/memtypes.rst
index e04049001d..952b316ea0 100644
--- a/doc/developer/memtypes.rst
+++ b/doc/developer/memtypes.rst
@@ -131,3 +131,10 @@ Usage
- if ptr is NULL, no operation is performed (as is guaranteed by system
implementations.) Do not surround XFREE with ``if (ptr != NULL)``
checks.
+
+.. c:function:: void XCOUNTFREE(struct memtype *mtype, void *ptr)
+
+ This macro is used to count the ``ptr`` as freed without actually freeing
+ it. This may be needed in some very specific cases, for example, when the
+ ``ptr`` was allocated using any of the above wrappers and will be freed
+ by some external library using simple ``free()``.