mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

improve annex.stalldetection documentation

Browse source
This commit is contained in:
Joey Hess 2024-01-18 14:38:16 -04:00
parent 931920c426
commit 8f655f7953
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/git-annex.mdwn
View file

@ -1528,16 +1528,16 @@ Remotes are configured using these settings in `.git/config`.
stalled operation. The transfer will be considered to have failed, so
settings like annex.retry will control what it does next.
By default, git-annex detects transfers that have probably stalled,
and suggests configuring this. If it is incorrectly detecting
stalls, setting this to "false" will avoid that.
Set to "true" to enable automatic stall detection. If a remote does not
update its progress consistently, no automatic stall detection will be
The default is to automatically detect when transfers that have probably
stalled, and suggest configuring this, but not cancel the stalled
operations. For this to work, a remote needs to update its progress
consistently. Remotes that do not will not have automatic stall detection
done. And it may take a while for git-annex to decide a remote is really
stalled when using automatic stall detection, since it needs to be
conservative about what looks like a stall.
Set to "false" to avoid all attempts at stall detection.
For more fine control over what constitutes a stall, set to a value in
the form "$amount/$timeperiod" to specify how much data git-annex should
expect to see flowing, minimum, over a given period of time.