summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGiampaolo Rodola <g.rodola@gmail.com>2022-01-16 20:06:14 +0100
committerGitHub <noreply@github.com>2022-01-16 20:06:14 +0100
commit98b49486f81f085bceda60b01b0a8f69a7008290 (patch)
tree23aead2f5fa0e6ae789f7f167100d493f045031e /docs
parent01f5f1ecb1b3470c1df2a120f0f6dca7f58088fb (diff)
downloadpsutil-98b49486f81f085bceda60b01b0a8f69a7008290.tar.gz
OpenBSD: add support for CPU frequency (#2057)
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 7c9e8ae3..6df7ccef 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -269,11 +269,11 @@ CPU
Return CPU frequency as a named tuple including *current*, *min* and *max*
frequencies expressed in Mhz.
On Linux *current* frequency reports the real-time value, on all other
- platforms it represents the nominal "fixed" value.
+ platforms this usually represents the nominal "fixed" value (never changing).
If *percpu* is ``True`` and the system supports per-cpu frequency
retrieval (Linux only) a list of frequencies is returned for each CPU,
if not, a list with a single element is returned.
- If *min* and *max* cannot be determined they are set to ``0``.
+ If *min* and *max* cannot be determined they are set to ``0.0``.
Example (Linux):
@@ -288,12 +288,14 @@ CPU
scpufreq(current=1703.609, min=800.0, max=3500.0),
scpufreq(current=1754.289, min=800.0, max=3500.0)]
- Availability: Linux, macOS, Windows, FreeBSD
+ Availability: Linux, macOS, Windows, FreeBSD, OpenBSD
.. versionadded:: 5.1.0
.. versionchanged:: 5.5.1 added FreeBSD support.
+ .. versionchanged:: 5.9.1 added OpenBSD support.
+
.. function:: getloadavg()
Return the average system load over the last 1, 5 and 15 minutes as a tuple.