From 8975c05d199558b0cc2e98f26ce33c6090d1d7a1 Mon Sep 17 00:00:00 2001 From: Ben Noordhuis Date: Tue, 8 Nov 2022 17:33:19 +0100 Subject: [PATCH] doc: document 0 return value for free/total memory (#3817) Refs: https://github.com/libuv/libuv/discussions/3809 --- docs/src/misc.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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)