summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGiampaolo Rodola <g.rodola@gmail.com>2017-09-08 12:24:49 +0800
committerGiampaolo Rodola <g.rodola@gmail.com>2017-09-08 12:24:49 +0800
commite950259b745317ceac9870d2acfcbfc7a946cbcb (patch)
treec0484d7f89452fb23b2e8738bc55668e444672e7
parent5c0dfc851950b820aa13ef66ce3ab25424aedcec (diff)
downloadpsutil-e950259b745317ceac9870d2acfcbfc7a946cbcb.tar.gz
update doc, bump up ver
-rw-r--r--HISTORY.rst9
-rw-r--r--docs/index.rst26
-rw-r--r--psutil/__init__.py2
3 files changed, 23 insertions, 14 deletions
diff --git a/HISTORY.rst b/HISTORY.rst
index 3fe6858b..7fe75490 100644
--- a/HISTORY.rst
+++ b/HISTORY.rst
@@ -1,5 +1,14 @@
*Bug tracker at https://github.com/giampaolo/psutil/issues*
+XXXX-XX-XX
+
+5.3.1
+=====
+
+**Enhancements**
+
+- 1124_: documentation moved to http://psutil.readthedocs.io
+
*2017-09-01*
5.3.0
diff --git a/docs/index.rst b/docs/index.rst
index e7081f7b..da730a7b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -694,7 +694,7 @@ Sensors
.. warning::
- This API is experimental. Backward incompatible changes may occur if
+ this API is experimental. Backward incompatible changes may occur if
deemed necessary.
.. function:: sensors_fans()
@@ -718,7 +718,7 @@ Sensors
.. warning::
- This API is experimental. Backward incompatible changes may occur if
+ this API is experimental. Backward incompatible changes may occur if
deemed necessary.
.. function:: sensors_battery()
@@ -760,7 +760,7 @@ Sensors
.. warning::
- This API is experimental. Backward incompatible changes may occur if
+ this API is experimental. Backward incompatible changes may occur if
deemed necessary.
Other system info
@@ -993,14 +993,13 @@ Process class
at the same time, make sure to use either :meth:`as_dict` or
:meth:`oneshot` context manager.
- .. warning::
+ .. note::
- the way this class is bound to a process is via its **PID**.
- That means that if the :class:`Process` instance is old enough and
- the PID has been reused in the meantime you might end up interacting
- with another process.
+ the way this class is bound to a process is uniquely via its **PID**.
+ That means that if the process terminates and the OS reuses its PID you may
+ end up interacting with another process.
The only exceptions for which process identity is preemptively checked
- (via PID + creation time) and guaranteed are for
+ (via PID + creation time) is for the following methods:
:meth:`nice` (set),
:meth:`ionice` (set),
:meth:`cpu_affinity` (set),
@@ -1010,12 +1009,13 @@ Process class
:meth:`suspend`
:meth:`resume`,
:meth:`send_signal`,
- :meth:`terminate`, and
- :meth:`kill`
- methods.
+ :meth:`terminate`
+ :meth:`kill`.
To prevent this problem for all other methods you can use
- :meth:`is_running()` before querying the process or use
+ :meth:`is_running()` before querying the process or
:func:`process_iter()` in case you're iterating over all processes.
+ It must be noted though that unless you deal with very "old" (inactive)
+ :class:`Process` instances this will hardly represent a problem.
.. method:: oneshot()
diff --git a/psutil/__init__.py b/psutil/__init__.py
index 50ae2a33..70f9bc06 100644
--- a/psutil/__init__.py
+++ b/psutil/__init__.py
@@ -203,7 +203,7 @@ __all__ = [
]
__all__.extend(_psplatform.__extra__all__)
__author__ = "Giampaolo Rodola'"
-__version__ = "5.3.0"
+__version__ = "5.3.1"
version_info = tuple([int(num) for num in __version__.split('.')])
AF_LINK = _psplatform.AF_LINK
POWER_TIME_UNLIMITED = _common.POWER_TIME_UNLIMITED