From d06e76bb243dda3843cfaefe7adc362aab2b7215 Mon Sep 17 00:00:00 2001 From: Oswin Nathanial Date: Tue, 13 Oct 2015 10:56:22 +0900 Subject: Update docstring for 'kill_after_timeout' parameter Specify that this feature is not supported on Windows and mention about the negative side-effects of SIGKILL on a repository. Change-Id: Ibba2c3f51f84084b4637ae9aaafa87dd84000ef4 --- git/cmd.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'git') diff --git a/git/cmd.py b/git/cmd.py index 4b267206..a7435497 100644 --- a/git/cmd.py +++ b/git/cmd.py @@ -537,7 +537,11 @@ class Git(LazyMixin): To specify a timeout in seconds for the git command, after which the process should be killed. This will have no effect if as_process is set to True. It is set to None by default and will let the process run until the timeout is - explicitly specified. + explicitly specified. This feature is not supported on Windows. It's also worth + noting that kill_after_timeout uses SIGKILL, which can have negative side + effects on a repository. For example, stale locks in case of git gc could + render the repository incapable of accepting changes until the lock is manually + removed. :return: * str(output) if extended_output = False (Default) -- cgit v1.2.1