diff options
| author | Ben Noordhuis <info@bnoordhuis.nl> | 2022-11-08 17:33:19 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-08 17:33:19 +0100 |
| commit | 8975c05d199558b0cc2e98f26ce33c6090d1d7a1 (patch) | |
| tree | b49784aa3531cca6fbd44f64bcd5f5a29e9dba54 /docs/src | |
| parent | 07949ce2aea6028ef597faf193b2fddf4a889036 (diff) | |
| download | libuv-8975c05d199558b0cc2e98f26ce33c6090d1d7a1.tar.gz libuv-8975c05d199558b0cc2e98f26ce33c6090d1d7a1.zip | |
doc: document 0 return value for free/total memory (#3817)
Refs: https://github.com/libuv/libuv/discussions/3809
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/misc.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/src/misc.rst b/docs/src/misc.rst index 423ef84c..a18040e2 100644 --- a/docs/src/misc.rst +++ b/docs/src/misc.rst @@ -551,11 +551,13 @@ API .. c:function:: uint64_t uv_get_free_memory(void) - Gets the amount of free memory available in the system, as reported by the kernel (in bytes). + Gets the amount of free memory available in the system, as reported by + the kernel (in bytes). Returns 0 when unknown. .. c:function:: uint64_t uv_get_total_memory(void) Gets the total amount of physical memory in the system (in bytes). + Returns 0 when unknown. .. c:function:: uint64_t uv_get_constrained_memory(void) |