misc.rst in libuv-3.0.0

- old
+ new

@@ -15,15 +15,15 @@
 
     Buffer data type.
 
     .. c:member:: char* uv_buf_t.base
 
-        Pointer to the base of the buffer. Readonly.
+        Pointer to the base of the buffer.
 
     .. c:member:: size_t uv_buf_t.len
 
-        Total bytes in the buffer. Readonly.
+        Total bytes in the buffer.
 
         .. note::
             On Windows this field is ULONG.
 
 .. c:type:: void* (*uv_malloc_func)(size_t size)
@@ -67,25 +67,28 @@
 
         typedef struct {
             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.
 
     ::
@@ -203,9 +206,10 @@
 
     Gets the resource usage measures for the current process.
 
     .. 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)
 
     Gets information about the CPUs on the system. The `cpu_infos` array will
     have `count` elements and needs to be freed with :c:func:`uv_free_cpu_info`.