Skip to content

Commit 7b828a0

Browse files
committed
Merge branch 'mm/remote-helpers-doc'
* mm/remote-helpers-doc: Documentation/remote-helpers: document common use-case for private ref
2 parents 8ee9a18 + 3f36eb4 commit 7b828a0

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
@@ -185,6 +185,12 @@ applicable refspec takes precedence. The left-hand of refspecs
185185
advertised with this capability must cover all refs reported by
186186
the list command. If no 'refspec' capability is advertised,
187187
there is an implied `refspec *:*`.
188+
+
189+
When writing remote-helpers for decentralized version control
190+
systems, it is advised to keep a local copy of the repository to
191+
interact with, and to let the private namespace refs point to this
192+
local repository, while the refs/remotes namespace is used to track
193+
the remote repository.
188194

189195
'bidi-import'::
190196
This modifies the 'import' capability.

0 commit comments

Comments
 (0)