aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorImran Iqbal <imran@imraniqbal.org>2016-09-08 23:22:32 -0400
committerImran Iqbal <imran@imraniqbal.org>2016-09-11 17:04:39 -0400
commit30d852f9e0070c7334a8a5eae7a7b1bc38ad9050 (patch)
tree0687a70da5b2159883f685c85b8c119d2a672ac6 /docs/src
parent0d7f72f219d379a6f42ec96ffd8a90493a0d4210 (diff)
downloadlibuv-30d852f9e0070c7334a8a5eae7a7b1bc38ad9050.tar.gz
libuv-30d852f9e0070c7334a8a5eae7a7b1bc38ad9050.zip
doc: update supported fields for uv_rusage_t
Fixes: https://github.com/libuv/libuv/issues/342 PR-URL: https://github.com/libuv/libuv/pull/1041 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/misc.rst24
1 files changed, 14 insertions, 10 deletions
diff --git a/docs/src/misc.rst b/docs/src/misc.rst
index d377cc8e..95237f49 100644
--- a/docs/src/misc.rst
+++ b/docs/src/misc.rst
@@ -69,21 +69,24 @@ Data types
uv_timeval_t ru_utime; /* user CPU time used */
uv_timeval_t ru_stime; /* system CPU time used */
uint64_t ru_maxrss; /* maximum resident set size */
- uint64_t ru_ixrss; /* integral shared memory size */
- uint64_t ru_idrss; /* integral unshared data size */
- uint64_t ru_isrss; /* integral unshared stack size */
- uint64_t ru_minflt; /* page reclaims (soft page faults) */
+ uint64_t ru_ixrss; /* integral shared memory size (X) */
+ uint64_t ru_idrss; /* integral unshared data size (X) */
+ uint64_t ru_isrss; /* integral unshared stack size (X) */
+ uint64_t ru_minflt; /* page reclaims (soft page faults) (X) */
uint64_t ru_majflt; /* page faults (hard page faults) */
- uint64_t ru_nswap; /* swaps */
+ uint64_t ru_nswap; /* swaps (X) */
uint64_t ru_inblock; /* block input operations */
uint64_t ru_oublock; /* block output operations */
- uint64_t ru_msgsnd; /* IPC messages sent */
- uint64_t ru_msgrcv; /* IPC messages received */
- uint64_t ru_nsignals; /* signals received */
- uint64_t ru_nvcsw; /* voluntary context switches */
- uint64_t ru_nivcsw; /* involuntary context switches */
+ uint64_t ru_msgsnd; /* IPC messages sent (X) */
+ uint64_t ru_msgrcv; /* IPC messages received (X) */
+ uint64_t ru_nsignals; /* signals received (X) */
+ uint64_t ru_nvcsw; /* voluntary context switches (X) */
+ uint64_t ru_nivcsw; /* involuntary context switches (X) */
} uv_rusage_t;
+ Members marked with `(X)` are unsupported on Windows.
+ See :man:`getrusage(2)` for supported fields on Unix
+
.. c:type:: uv_cpu_info_t
Data type for CPU information.
@@ -205,6 +208,7 @@ API
.. note::
On Windows not all fields are set, the unsupported fields are filled with zeroes.
+ See :c:type:`uv_rusage_t` for more details.
.. c:function:: int uv_cpu_info(uv_cpu_info_t** cpu_infos, int* count)