From 9a3a0ccc502f8799db34b7937a0e588980a8922d Mon Sep 17 00:00:00 2001 From: Ben Noordhuis Date: Tue, 15 Oct 2013 10:01:50 +0200 Subject: [PATCH] doc: expand os.loadavg() section Add a short explanation of what the load average is and why it's unavailable on Windows. Also sneak in a fix for a typo that I introduced in commit 56c5806. --- doc/api/os.markdown | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/api/os.markdown b/doc/api/os.markdown index 177f4992494..7aa710585b0 100644 --- a/doc/api/os.markdown +++ b/doc/api/os.markdown @@ -41,7 +41,14 @@ Returns the system uptime in seconds. ## os.loadavg() Returns an array containing the 1, 5, and 15 minute load averages. -This function always return `[0, 0, 0]` on Windows. + +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()