Skip to content

Commit 3f36eb4

Browse files
moygitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e230c56 commit 3f36eb4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Documentation/gitremote-helpers.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,12 @@ applicable refspec takes precedence. The left-hand of refspecs
176176
advertised with this capability must cover all refs reported by
177177
the list command. If no 'refspec' capability is advertised,
178178
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.
179185

180186
'bidi-import'::
181187
This modifies the 'import' capability.

0 commit comments

Comments
 (0)