martin/emacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation of 'malloc-trim'

Browse Source 
* src/alloc.c (Fmalloc_trim): Fix the doc string.

* etc/NEWS: Document which systems support 'malloc-trim'.
This commit is contained in:
Eli Zaretskii
2022-05-01 13:06:33 +03:00
parent 29f3d4d2c6
commit 8734d60b05
2 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
etc/NEWS
View File

@@ -1547,7 +1547,8 @@ functions.
---
** New function 'malloc-trim'.
This function allows returning unused memory back to the operating
system, and is mainly meant as a debugging tool.
system, and is mainly meant as a debugging tool. It is currently
available only when Emacs was built with glibc as the C library.
---
** 'x-show-tip' no longer hard-codes a timeout default.

8
src/alloc.c
View File

@@ -7481,14 +7481,14 @@ arenas. */)
#ifdef HAVE_MALLOC_TRIM
DEFUN ("malloc-trim", Fmalloc_trim, Smalloc_trim, 0, 1, "",
doc: /* Release free memory from the heap.
This function asks libc to return unused memory back to the operating
doc: /* Release free heap memory to the OS.
This function asks libc to return unused heap memory back to the operating
system. This function isn't guaranteed to do anything, and is mainly
meant as a debugging tool.
If LEAVE_PADDING is given, ask the system to leave that much unused
spaced in the heap. This should be an integer, and if not given,
defaults to 0.
space in the heap of the Emacs process. This should be an integer, and if
not given, it defaults to 0.
This function returns nil if no memory could be returned to the
system, and non-nil if some memory could be returned. */)