Skip to content

Commit cab037c

Browse files
committed
Merge branch 'dt/remote-helper-doc-re-lock-option'
Doc update. * dt/remote-helper-doc-re-lock-option: clarify documentation for remote helpers
2 parents 8e111e4 + 0a8bc70 commit cab037c

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

Documentation/gitremote-helpers.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -297,9 +297,13 @@ Supported if the helper has the "option" capability.
297297
same batch are complete. Only objects which were reported
298298
in the output of 'list' with a sha1 may be fetched this way.
299299
+
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.
303307
+
304308
If option 'check-connectivity' is requested, the helper must output
305309
'connectivity-ok' if the clone is self-contained and connected.

0 commit comments

Comments
 (0)