]> dgit.raspbian.org Git - git-annex.git/commitdiff
mention annex.stalldetection and don't recommend too infrequent progress updates
authorJoey Hess <joeyh@joeyh.name>
Fri, 11 Dec 2020 22:24:21 +0000 (18:24 -0400)
committerJoey Hess <joeyh@joeyh.name>
Fri, 11 Dec 2020 22:26:24 +0000 (18:26 -0400)
doc/design/external_special_remote_protocol.mdwn

index a8165e586df214b105181d4e3f9050fd0c7653b6..eaf3f95943541046d90838bcb2e856d8d44f5b85 100644 (file)
@@ -272,7 +272,10 @@ handling a request.
 * `PROGRESS Int`  
   Indicates the current progress of the transfer (in bytes). May be repeated
   any number of times during the transfer process, but it's wasteful to
-  update the progress until at least another 1% of the file has been sent.
+  update the progress too frequently. Bear in mind that this is used both
+  to display a progress meter for the user, and for annex.stalldetection.
+  So, sending an update on each 1% of the file may not be frequent enough,
+  as it could appear to be a stall when transferring a large file.  
   This is highly recommended for STORE. (It is optional but good for RETRIEVE.)  
   (git-annex does not send a reply to this message.)
 * `DIRHASH Key`