summaryrefslogtreecommitdiff
path: root/git/cmd.py
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2015-10-15 09:21:09 +0200
committerSebastian Thiel <byronimo@gmail.com>2015-10-15 09:21:41 +0200
commit3cb5e177e5d7931e30b198b06b21809ef6a78b92 (patch)
treea2f6ddad5728613c15c337a274bc9c96bbd49609 /git/cmd.py
parentec401e4807165485a4b7a2dad4f74e373ced35ae (diff)
downloadgitpython-3cb5e177e5d7931e30b198b06b21809ef6a78b92.tar.gz
doc(cmd): make sure people know wait() may block
Related to #357
Diffstat (limited to 'git/cmd.py')
-rw-r--r--git/cmd.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/git/cmd.py b/git/cmd.py
index 3cdc68ab..45678013 100644
--- a/git/cmd.py
+++ b/git/cmd.py
@@ -12,6 +12,7 @@ import logging
import threading
import errno
import mmap
+import warnings
from contextlib import contextmanager
from subprocess import (
@@ -309,6 +310,7 @@ class Git(LazyMixin):
def wait(self):
"""Wait for the process and return its status code.
+ :warn: may deadlock if output or error pipes are used and not handled separately.
:raise GitCommandError: if the return status is not 0"""
status = self.proc.wait()
if status != 0: