diff options
Diffstat (limited to 'doc/api/os.markdown')
| -rw-r--r-- | doc/api/os.markdown | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/api/os.markdown b/doc/api/os.markdown index 928a79e881..58a80d074d 100644 --- a/doc/api/os.markdown +++ b/doc/api/os.markdown @@ -43,6 +43,14 @@ Returns the system uptime in seconds. Returns an array containing the 1, 5, and 15 minute load averages. +The load average is a measure of system activity, calculated by the operating +system and expressed as a fractional number. As a rule of thumb, the load +average should ideally be less than the number of logical CPUs in the system. + +The load average is a very UNIX-y concept; there is no real equivalent on +Windows platforms. That is why this function always returns `[0, 0, 0]` on +Windows. + ## os.totalmem() Returns the total amount of system memory in bytes. |