clarify documentation for remote helpers
Signed-off-by: David Turner <dturner@twosigma.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
David Turner committed
Aug 30, 2019 at 16:12 UTC
0a8bc7068f0bb780ce1f3cb27c4277daed2dbdcd
1 file changed
+7
-3
Documentation/gitremote-helpers.txt
+7
-3
@@ -297,9 +297,13 @@ Supported if the helper has the "option" capability.
297
same batch are complete. Only objects which were reported
298
in the output of 'list' with a sha1 may be fetched this way.
299
+
300
-Optionally may output a 'lock <file>' line indicating a file under
301
-GIT_DIR/objects/pack which is keeping a pack until refs can be
302
-suitably updated.
300
+Optionally may output a 'lock <file>' line indicating the full path of
301
+a file under `$GIT_DIR/objects/pack` which is keeping a pack until
302
+refs can be suitably updated. The path must end with `.keep`. This is
303
+a mechanism to name a <pack,idx,keep> tuple by giving only the keep
304
+component. The kept pack will not be deleted by a concurrent repack,
305
+even though its objects may not be referenced until the fetch completes.
306
+The `.keep` file will be deleted at the conclusion of the fetch.
307
+
308
If option 'check-connectivity' is requested, the helper must output
309
'connectivity-ok' if the clone is self-contained and connected.