Skip to content

Include 'timeout' parameter in Git execute #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 16, 2015
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
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
  • Loading branch information
OswinNathanial authored and dpursehouse committed Oct 13, 2015
commit d06e76bb243dda3843cfaefe7adc362aab2b7215
6 changes: 5 additions & 1 deletion git/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,11 @@ def execute(self, command,
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)
Expand Down