(short) documentation for the testgit remote helper
authorMatthieu Moy <Matthieu.Moy@imag.fr>
Thu, 1 Sep 2011 16:49:38 +0000 (18:49 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 1 Sep 2011 22:52:02 +0000 (15:52 -0700)
While it's not a command meant to be used by actual users (hence, not
mentionned in git(1)), this command is a very precious help for
remote-helpers authors.

The best place for such technical doc is the source code, but users may
not find it without a link in a manpage.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-remote-testgit.txt [new file with mode: 0644]

index 526fc6a..674797c 100644 (file)
@@ -362,6 +362,8 @@ SEE ALSO
 Part of the linkgit:git[1] suite
diff --git a/Documentation/git-remote-testgit.txt b/Documentation/git-remote-testgit.txt
new file mode 100644 (file)
index 0000000..2a67d45
--- /dev/null
@@ -0,0 +1,30 @@
+git-remote-testgit - Example remote-helper
+git clone testgit::<source-repo> [<destination>]
+This command is a simple remote-helper, that is used both as a
+testcase for the remote-helper functionality, and as an example to
+show remote-helper authors one possible implementation.
+The best way to learn more is to read the comments and source code in
+Part of the linkgit:git[1] suite
index e9c832b..3dc4851 100644 (file)
@@ -1,5 +1,18 @@
 #!/usr/bin/env python
+# This command is a simple remote-helper, that is used both as a
+# testcase for the remote-helper functionality, and as an example to
+# show remote-helper authors one possible implementation.
+# This is a Git <-> Git importer/exporter, that simply uses git
+# fast-import and git fast-export to consume and produce fast-import
+# streams.
+# To understand better the way things work, one can activate debug
+# traces by setting (to any value) the environment variables
+# from the transport-helper side, or from this example remote-helper.
 # hashlib is only available in python >= 2.5
     import hashlib