{"thread":{"id":"51781","subject":"[PATCH v3] clarify documentation for remote helpers","startedAt":"2019-08-30T20:12:48Z","lastAt":"2019-08-30T20:12:48Z","messageCount":1,"participants":["David Turner"],"isPatch":true,"patchVersion":3,"patchTotal":null},"messages":[{"id":"381610","messageId":"20190830201218.21651-1-dturner@twosigma.com","threadId":"51781","inReplyTo":null,"subject":"[PATCH v3] clarify documentation for remote helpers","fromName":"David Turner","fromEmail":"dturner@twosigma.com","sentAt":"2019-08-30T20:12:18Z","receivedAt":"2019-08-30T20:12:48Z","isPatch":true,"sender":{"key":"novalis@novalis.org","avatar":"https://avatars.githubusercontent.com/u/77003?v=4"},"body":"Signed-off-by: David Turner <dturner@twosigma.com>\n---\n Documentation/gitremote-helpers.txt | 10 +++++++---\n 1 file changed, 7 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt\nindex 43f80c8068..a5c3c04371 100644\n--- a/Documentation/gitremote-helpers.txt\n+++ b/Documentation/gitremote-helpers.txt\n@@ -297,9 +297,13 @@ Supported if the helper has the \"option\" capability.\n \tsame batch are complete. Only objects which were reported\n \tin the output of 'list' with a sha1 may be fetched this way.\n +\n-Optionally may output a 'lock <file>' line indicating a file under\n-GIT_DIR/objects/pack which is keeping a pack until refs can be\n-suitably updated.\n+Optionally may output a 'lock <file>' line indicating the full path of\n+a file under `$GIT_DIR/objects/pack` which is keeping a pack until\n+refs can be suitably updated.  The path must end with `.keep`. This is\n+a mechanism to name a <pack,idx,keep> tuple by giving only the keep\n+component.  The kept pack will not be deleted by a concurrent repack,\n+even though its objects may not be referenced until the fetch completes.\n+The `.keep` file will be deleted at the conclusion of the fetch.\n +\n If option 'check-connectivity' is requested, the helper must output\n 'connectivity-ok' if the clone is self-contained and connected.\n-- \n2.20.1\n\n"}]}