summaryrefslogtreecommitdiff
path: root/xmake/core/base/memory.lua
diff options
context:
space:
mode:
Diffstat (limited to 'xmake/core/base/memory.lua')
-rw-r--r--xmake/core/base/memory.lua4
1 files changed, 4 insertions, 0 deletions
diff --git a/xmake/core/base/memory.lua b/xmake/core/base/memory.lua
index ff52658e5..5225a3c8a 100644
--- a/xmake/core/base/memory.lua
+++ b/xmake/core/base/memory.lua
@@ -25,6 +25,10 @@ local memory = memory or {}
local os = require("base/os")
-- get memory info
+--
+-- @param name the specific info name (optional), e.g. "totalsize", "availsize", "usagerate"
+-- @return the memory info table or specific value (sizes in bytes, usagerate in 0.0 ~ 1.0)
+--
function memory.info(name)
local meminfo = memory._MEMINFO
local memtime = memory._MEMTIME