summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGiampaolo Rodola <g.rodola@gmail.com>2017-11-12 04:04:59 +0100
committerGiampaolo Rodola <g.rodola@gmail.com>2017-11-12 04:04:59 +0100
commit589e1c52e2ee2a5bd45fe27fe95cb212e743fd9e (patch)
tree57cff2b4d0b672b276de737e4dd6578d1a9a9e24
parent81deaa81713656c48320b0ca0e89384a3eca0616 (diff)
downloadpsutil-589e1c52e2ee2a5bd45fe27fe95cb212e743fd9e.tar.gz
update doc
-rw-r--r--docs/index.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst
index befd5dca..620fea46 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2305,16 +2305,17 @@ Debug mode
In case you bump into nasty errors which look like being psutil's fault you may
want to run psutil in debug mode. psutil may (or may not) print some useful
-message on stderr before crashing with an exception.
+message on stderr before crashing with an exception
+(see `original motivation <https://github.com/giampaolo/psutil/issues/1173>`__).
To enable debug mode on UNIX:
-::
+.. code-block:: bash
PSUTIL_DEBUG=1 python script.py
On Windows:
-::
+.. code-block:: bat
set PSUTIL_DEBUG=1 && C:\python36\python.exe script.py