summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGiampaolo Rodola <g.rodola@gmail.com>2017-02-08 15:24:18 +0100
committerGiampaolo Rodola <g.rodola@gmail.com>2017-02-08 15:24:18 +0100
commit137f704fb162023eae9510b8c67227d48beb9032 (patch)
tree4000d4b87d233647e5f4ec3a2bfbf69f3e5a37f4
parente5a32988815641e0fee816ba4d2c6d779167f4c6 (diff)
downloadpsutil-137f704fb162023eae9510b8c67227d48beb9032.tar.gz
update doc
-rw-r--r--docs/index.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/index.rst b/docs/index.rst
index df383739..1a0438a1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1185,7 +1185,7 @@ Process class
Return process I/O statistics as a named tuple including the number of read
and write operations performed by the process and the amount of bytes read
- and written. For Linux refer to
+ and written (cumulative). For Linux you can refer to
`/proc filesysem documentation <https://www.kernel.org/doc/Documentation/filesystems/proc.txt>`__.
On BSD there's apparently no way to retrieve bytes counters, hence ``-1``
is returned for **read_bytes** and **write_bytes** fields. OSX is not
@@ -1201,23 +1201,24 @@ Process class
.. method:: num_ctx_switches()
The number voluntary and involuntary context switches performed by
- this process.
+ this process (cumulative).
.. method:: num_fds()
- The number of file descriptors used by this process.
+ The number of file descriptors currently opened by this process
+ (non cumulative).
Availability: UNIX
.. method:: num_handles()
- The number of handles used by this process.
+ The number of handles currently used by this process (non cumulative).
Availability: Windows
.. method:: num_threads()
- The number of threads used by this process.
+ The number of threads currently used by this process (non cumulative).
.. method:: threads()