From 3cb5e177e5d7931e30b198b06b21809ef6a78b92 Mon Sep 17 00:00:00 2001
From: Sebastian Thiel <byronimo@gmail.com>
Date: Thu, 15 Oct 2015 09:21:09 +0200
Subject: doc(cmd): make sure people know wait() may block

Related to #357
---
 git/cmd.py | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'git/cmd.py')

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:
-- 
cgit v1.2.1