diff options
| author |  David Turner <dturner@twosigma.com> | 2019-08-30 16:12:18 -0400 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2019-08-30 14:39:50 -0700 |
| commit | 0a8bc7068f0bb780ce1f3cb27c4277daed2dbdcd (patch) | |
| tree | 9a5ff4517674e58916ab3eae30a3406106d2b2de | |
| parent | Git 2.22.1 (diff) | |
| download | tgif-0a8bc7068f0bb780ce1f3cb27c4277daed2dbdcd.tar.xz | |
clarify documentation for remote helpers
Signed-off-by: David Turner <dturner@twosigma.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/gitremote-helpers.txt | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt index 43f80c8068..a5c3c04371 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. |