doc(cmd): make sure people know wait() may block

Byron · Byron · commit 3cb5e177e5d7 · 2015-10-15T09:21:41.000+02:00
Related to #357
diff --git a/git/cmd.py b/git/cmd.py
@@ -12,6 +12,7 @@
 import threading
 import errno
 import mmap
+import warnings
 
 from contextlib import contextmanager
 from subprocess import (
@@ -309,6 +310,7 @@ def __getattr__(self, attr):
         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:
