path: root/Documentation/gitremote-helpers.txt
diff options
authorDavid Turner <>2019-08-30 20:12:18 (GMT)
committerJunio C Hamano <>2019-08-30 21:39:50 (GMT)
commit0a8bc7068f0bb780ce1f3cb27c4277daed2dbdcd (patch)
tree9a5ff4517674e58916ab3eae30a3406106d2b2de /Documentation/gitremote-helpers.txt
parent75b2f01a0f642b39b0f29b6218515df9b5eb798e (diff)
clarify documentation for remote helpers
Signed-off-by: David Turner <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/gitremote-helpers.txt')
1 files changed, 7 insertions, 3 deletions
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index 43f80c8..a5c3c04 100644
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -297,9 +297,13 @@ Supported if the helper has the "option" capability.
same batch are complete. Only objects which were reported
in the output of 'list' with a sha1 may be fetched this way.
-Optionally may output a 'lock <file>' line indicating a file under
-GIT_DIR/objects/pack which is keeping a pack until refs can be
-suitably updated.
+Optionally may output a 'lock <file>' line indicating the full path of
+a file under `$GIT_DIR/objects/pack` which is keeping a pack until
+refs can be suitably updated. The path must end with `.keep`. This is
+a mechanism to name a <pack,idx,keep> tuple by giving only the keep
+component. The kept pack will not be deleted by a concurrent repack,
+even though its objects may not be referenced until the fetch completes.
+The `.keep` file will be deleted at the conclusion of the fetch.
If option 'check-connectivity' is requested, the helper must output
'connectivity-ok' if the clone is self-contained and connected.