Update docs

electron · Nov 20, 2018 · 1887224 · 1887224
1 parent 88f43c6
commit 1887224
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/docs/api/process.md b/docs/api/process.md
@@ -162,16 +162,21 @@ Returns an object with V8 heap statistics. Note that all statistics are reported
 Returns `Object`:
 
 * `residentSet` Integer _Linux_ and _Windows_ - The amount of memory 
-currently pinned to actual physical RAM.
+currently pinned to actual physical RAM in Kilobytes.
 * `private` Integer - The amount of memory not shared by other processes, such as
-  JS heap or HTML content.
+  JS heap or HTML content in Kilobytes.
 * `shared` Integer - The amount of memory shared between processes, typically
-  memory consumed by the Electron code itself.
+  memory consumed by the Electron code itself in Kilobytes.
 
 Returns an object giving memory usage statistics about the current process. Note
 that all statistics are reported in Kilobytes.
 This api should be called after app ready.
 
+Chromium does not provide `residentSet` value for macos. This is because macos 
+performs in-memory compression of pages that haven't been recently used. As a
+result the resident set size value is not what one would expect. `private` memory
+is more representative of the actual pre-compression memory usage of the process.
+
 ### `process.getSystemMemoryInfo()`
 
 Returns `Object`: