[PATCH] Documentation/remote-helpers: document common use-case for private ref
From: Matthieu Moy <hidden>
Date: 2016-06-15 22:58:30
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
The current documentation mentions the private ref namespace, but does not really explain why it can be useful. Signed-off-by: Matthieu Moy <redacted> --- This small patch was sent inline during a previous conversation, but did not really catch attention ;-). Resending as a proper patch. Documentation/gitremote-helpers.txt | 6 ++++++ 1 file changed, 6 insertions(+)
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. 'bidi-import':: This modifies the 'import' capability.
--
1.8.4.rc4.4.g57d5d3d