Merge branch 'en/merge-recursive-directory-rename-fixes'

[thirdparty/git.git] / Documentation / gitremote-helpers.txt

diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index 43f80c80683805f97a71220005af7a0e862b8cca..f48a031dc346a307aa33aebc62686709a18673f6 100644 (file)
--- 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.
 +
        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.
 +
 If option 'check-connectivity' is requested, the helper must output
 'connectivity-ok' if the clone is self-contained and connected.


@@ -505,6 +509,11 @@ set by Git if the remote helper has the 'option' capability.
        Indicate that only the objects wanted need to be fetched, not
        their dependents.
 
        Indicate that only the objects wanted need to be fetched, not
        their dependents.
 

+'option atomic' {'true'|'false'}::
+       When pushing, request the remote server to update refs in a single atomic
+       transaction.  If successful, all refs will be updated, or none will.  If the
+       remote side does not support this capability, the push will fail.
+

 SEE ALSO
 --------
 linkgit:git-remote[1]
 SEE ALSO
 --------
 linkgit:git-remote[1]