summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGiampaolo Rodola <g.rodola@gmail.com>2021-05-03 13:33:16 +0200
committerGiampaolo Rodola <g.rodola@gmail.com>2021-05-03 13:33:16 +0200
commit4d30272e3de81a0c4244143595284e040cfb070f (patch)
treebe800c8d557f05b340479d11b8d897ba4a9c2b21 /docs
parentb035d1f8f3bd4cea7a0a7817c21ef161f2bb2fd7 (diff)
downloadpsutil-4d30272e3de81a0c4244143595284e040cfb070f.tar.gz
Re. #1210: add doc warning explaining that cpu_times() values can sometimes go backwards
Signed-off-by: Giampaolo Rodola <g.rodola@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 079b313c..a884ec80 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -144,6 +144,12 @@ CPU
.. versionchanged:: 4.1.0 added *interrupt* and *dpc* fields on Windows.
+ .. warning::
+ CPU times are always supposed to increase over time, or at least remain
+ the same, and that's because time cannot go backwards.
+ Surprisingly sometimes this might not be the case (at least on Windows
+ and Linux), see `#1210 <https://github.com/giampaolo/psutil/issues/1210#issuecomment-363046156>`__.
+
.. function:: cpu_percent(interval=None, percpu=False)
Return a float representing the current system-wide CPU utilization as a