Commitd06e76b

OswinNathanial

authored and

dpursehouse

committed

Update docstring for 'kill_after_timeout' parameter

Specify that this feature is not supported on Windows andmention about the negative side-effects of SIGKILL on arepository.Change-Id: Ibba2c3f51f84084b4637ae9aaafa87dd84000ef4

1 parent4faf5cd commitd06e76bCopy full SHA for d06e76b

File tree

1 file changed

-1

lines changed

git
- cmd.py

1 file changed

-1

lines changed

`‎git/cmd.py`

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -537,7 +537,11 @@ def execute(self, command,`
`537`	`537`	`To specify a timeout in seconds for the git command, after which the process`
`538`	`538`	`should be killed. This will have no effect if as_process is set to True. It is`
`539`	`539`	`set to None by default and will let the process run until the timeout is`
`540`		`- explicitly specified.`
	`540`	`+ explicitly specified. This feature is not supported on Windows. It's also worth`
	`541`	`+ noting that kill_after_timeout uses SIGKILL, which can have negative side`
	`542`	`+ effects on a repository. For example, stale locks in case of git gc could`
	`543`	`+ render the repository incapable of accepting changes until the lock is manually`
	`544`	`+ removed.`
`541`	`545`
`542`	`546`	`:return:`
`543`	`547`	`* str(output) if extended_output = False (Default)`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commitd06e76b

File tree

1 file changed

1 file changed

`‎git/cmd.py`

0 commit comments