path: root/Documentation/gitremote-helpers.txt
diff options
authorMatthieu Moy <>2013-08-26 09:21:39 (GMT)
committerJunio C Hamano <>2013-08-26 16:31:04 (GMT)
commit3f36eb43059aef4ec0f40fd8cc7081c0a1a92c31 (patch)
tree766150a2bc96fe64d3b7f1b5f27794677a698faf /Documentation/gitremote-helpers.txt
parente230c568c4b9a991e3175e5f65171a566fd8e39c (diff)
Documentation/remote-helpers: document common use-case for private ref
The current documentation mentions the private ref namespace, but does not really explain why it can be useful. Signed-off-by: Matthieu Moy <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/gitremote-helpers.txt')
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index 0827f69..9ae36da 100644
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -176,6 +176,12 @@ applicable refspec takes precedence. The left-hand of refspecs
advertised with this capability must cover all refs reported by
the list command. If no 'refspec' capability is advertised,
there is an implied `refspec *:*`.
+When writing remote-helpers for decentralized version control
+systems, it is advised to keep a local copy of the repository to
+interact with, and to let the private namespace refs point to this
+local repository, while the refs/remotes namespace is used to track
+the remote repository.
This modifies the 'import' capability.