diff options
author | Giampaolo Rodola <g.rodola@gmail.com> | 2020-02-04 14:56:07 +0100 |
---|---|---|
committer | Giampaolo Rodola <g.rodola@gmail.com> | 2020-02-04 14:56:07 +0100 |
commit | fe988700b383246cbfc8540920039816cab0812e (patch) | |
tree | d8534f3d9452d86d9acb0e7e626ae9833dac9c25 /docs | |
parent | 96cc7ea40d6f4f08e86677434213cef119cf1748 (diff) | |
download | psutil-fe988700b383246cbfc8540920039816cab0812e.tar.gz |
#1610: clarify in the doc what cpu_count means
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst index 74dddd23..f552bbfa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -186,8 +186,10 @@ CPU Return the number of logical CPUs in the system (same as `os.cpu_count`_ in Python 3.4) or ``None`` if undetermined. - If *logical* is ``False`` return the number of physical cores only (hyper - thread CPUs are excluded) or ``None`` if undetermined. + *logical* cores means the number of physical cores multiplied by the number + of threads that can run on each core (this is known as Hyper Threading). + If *logical* is ``False`` return the number of physical cores only (Hyper + Thread CPUs are excluded) or ``None`` if undetermined. On OpenBSD and NetBSD ``psutil.cpu_count(logical=False)`` always return ``None``. Example on a system having 2 physical hyper-thread CPU cores: |