diff options
| author | Oswin Nathanial <oswin.x.nathanial@sonymobile.com> | 2015-10-13 10:56:22 +0900 |
|---|---|---|
| committer | David Pursehouse <david.pursehouse@sonymobile.com> | 2015-10-13 13:53:20 +0900 |
| commit | d06e76bb243dda3843cfaefe7adc362aab2b7215 (patch) | |
| tree | a2e5ac1b79328c61f127d67ef664f217d4c6511a /git | |
| parent | 4faf5cd43dcd0b3eea0a3e71077c21f4d029eb99 (diff) | |
| download | gitpython-d06e76bb243dda3843cfaefe7adc362aab2b7215.tar.gz | |
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
Diffstat (limited to 'git')
| -rw-r--r-- | git/cmd.py | 6 |
1 files changed, 5 insertions, 1 deletions
@@ -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) |