[PATCH] clarify documentation for remote helpers
- From
David Turner <dturner@twosigma.com>
- Date
- Aug 29, 2019, 21:03 UTC
- Message-ID
- <20190829210301.18467-1-dturner@twosigma.com>
Signed-off-by: David Turner <dturner@twosigma.com> ---
This doesn't address the connectivity-ok problem, which I continue to worry is a real bug. But it would have saved me a few minutes of debugging.
Documentation/gitremote-helpers.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt index 43f80c8068..30001b2054 100644 --- a/Documentation/gitremote-helpers.txt +++ b/Documentation/gitremote-helpers.txt @@ -297,9 +297,9 @@ 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 under GIT_DIR/objects/pack which is keeping a pack until +refs can be suitably updated. The path must end with ".keep". + If option 'check-connectivity' is requested, the helper must output 'connectivity-ok' if the clone is self-contained and connected.
-- 2.20.1