From 8f655f7953ca30a72abed21d3aa2bb45c306392e Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 18 Jan 2024 14:38:16 -0400 Subject: [PATCH] improve annex.stalldetection documentation --- doc/git-annex.mdwn | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 0150643ed9..b127c317e5 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -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. -- 2.30.2