improve annex.stalldetection documentation

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

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