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 <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Matthieu Moy committed
Aug 26, 2013 at 11:21 UTC
3f36eb43059aef4ec0f40fd8cc7081c0a1a92c31
1 file changed
+6
Documentation/gitremote-helpers.txt
+6
@@ -176,6 +176,12 @@ applicable refspec takes precedence. The left-hand of refspecs
176
advertised with this capability must cover all refs reported by
177
the list command. If no 'refspec' capability is advertised,
178
there is an implied `refspec *:*`.
179
++
180
+When writing remote-helpers for decentralized version control
181
+systems, it is advised to keep a local copy of the repository to
182
+interact with, and to let the private namespace refs point to this
183
+local repository, while the refs/remotes namespace is used to track
184
+the remote repository.
185
186
'bidi-import'::
187
This modifies the 'import' capability.