diff options
| author | Eli Zaretskii | 2022-05-01 13:06:33 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2022-05-01 13:06:33 +0300 |
| commit | 8734d60b053852a6cf4dca59da4c5876820fa7d2 (patch) | |
| tree | dfbb1c1e7fdd35862e4fdb17afa1dbe1ed31315a /src/alloc.c | |
| parent | 29f3d4d2c69a0e9d2ab0a13ee6952fa9cf4d6035 (diff) | |
| download | emacs-8734d60b053852a6cf4dca59da4c5876820fa7d2.tar.gz emacs-8734d60b053852a6cf4dca59da4c5876820fa7d2.zip | |
Improve documentation of 'malloc-trim'
* src/alloc.c (Fmalloc_trim): Fix the doc string.
* etc/NEWS: Document which systems support 'malloc-trim'.
Diffstat (limited to 'src/alloc.c')
| -rw-r--r-- | src/alloc.c | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/alloc.c b/src/alloc.c index 661f37dd5cc..43fbbb79bed 100644 --- a/src/alloc.c +++ b/src/alloc.c | |||
| @@ -7481,14 +7481,14 @@ arenas. */) | |||
| 7481 | 7481 | ||
| 7482 | #ifdef HAVE_MALLOC_TRIM | 7482 | #ifdef HAVE_MALLOC_TRIM |
| 7483 | DEFUN ("malloc-trim", Fmalloc_trim, Smalloc_trim, 0, 1, "", | 7483 | DEFUN ("malloc-trim", Fmalloc_trim, Smalloc_trim, 0, 1, "", |
| 7484 | doc: /* Release free memory from the heap. | 7484 | doc: /* Release free heap memory to the OS. |
| 7485 | This function asks libc to return unused memory back to the operating | 7485 | This function asks libc to return unused heap memory back to the operating |
| 7486 | system. This function isn't guaranteed to do anything, and is mainly | 7486 | system. This function isn't guaranteed to do anything, and is mainly |
| 7487 | meant as a debugging tool. | 7487 | meant as a debugging tool. |
| 7488 | 7488 | ||
| 7489 | If LEAVE_PADDING is given, ask the system to leave that much unused | 7489 | If LEAVE_PADDING is given, ask the system to leave that much unused |
| 7490 | spaced in the heap. This should be an integer, and if not given, | 7490 | space in the heap of the Emacs process. This should be an integer, and if |
| 7491 | defaults to 0. | 7491 | not given, it defaults to 0. |
| 7492 | 7492 | ||
| 7493 | This function returns nil if no memory could be returned to the | 7493 | This function returns nil if no memory could be returned to the |
| 7494 | system, and non-nil if some memory could be returned. */) | 7494 | system, and non-nil if some memory could be returned. */) |