improve annex.stalldetection documentation
authorJoey Hess <joeyh@joeyh.name>
Thu, 18 Jan 2024 18:38:16 +0000 (14:38 -0400)
committerJoey Hess <joeyh@joeyh.name>
Thu, 18 Jan 2024 18:38:16 +0000 (14:38 -0400)
doc/git-annex.mdwn

index 0150643ed9c971159cd68bba7a44a12c9247fab3..b127c317e5f08da931235f4daf8b9a0f544672aa 100644 (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.