summaryrefslogtreecommitdiff
path: root/git-remote-testgit.py
diff options
context:
space:
mode:
authorMatthieu Moy <Matthieu.Moy@imag.fr>2011-09-01 18:49:38 +0200
committerJunio C Hamano <gitster@pobox.com>2011-09-01 15:52:02 -0700
commit9609dc9ddcb1a79112eb45c88244cdbb622bd5bc (patch)
tree5406bcb378a642a28ad12d8931183fff300650b5 /git-remote-testgit.py
parent960e3114963dbb290c12f7a4d19c5776584d43ff (diff)
downloadgit-9609dc9ddcb1a79112eb45c88244cdbb622bd5bc.tar.gz
(short) documentation for the testgit remote helper
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>
Diffstat (limited to 'git-remote-testgit.py')
-rw-r--r--git-remote-testgit.py13
1 files changed, 13 insertions, 0 deletions
diff --git a/git-remote-testgit.py b/git-remote-testgit.py
index e9c832bfd3..3dc4851cfc 100644
--- a/git-remote-testgit.py
+++ b/git-remote-testgit.py
@@ -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
+# GIT_TRANSPORT_HELPER_DEBUG and GIT_DEBUG_TESTGIT, to see messages
+# from the transport-helper side, or from this example remote-helper.
+
# hashlib is only available in python >= 2.5
try:
import hashlib