(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>
Matthieu Moy committed
Sep 1, 2011 at 18:49 UTC
9609dc9ddcb1a79112eb45c88244cdbb622bd5bc
3 files changed
+45
Documentation/git-remote-helpers.txt
+2
@@ -362,6 +362,8 @@ SEE ALSO
362
--------
363
linkgit:git-remote[1]
364
365
+linkgit:git-remote-testgit[1]
366
+
367
GIT
368
---
369
Part of the linkgit:git[1] suite
Documentation/git-remote-testgit.txt
new
+30
@@ -0,0 +1,30 @@
1
+git-remote-testgit(1)
2
+=====================
3
+
4
+NAME
5
+----
6
+git-remote-testgit - Example remote-helper
7
+
8
+
9
+SYNOPSIS
10
+--------
11
+[verse]
12
+git clone testgit::<source-repo> [<destination>]
13
+
14
+DESCRIPTION
15
+-----------
16
+
17
+This command is a simple remote-helper, that is used both as a
18
+testcase for the remote-helper functionality, and as an example to
19
+show remote-helper authors one possible implementation.
20
+
21
+The best way to learn more is to read the comments and source code in
22
+'git-remote-testgit.py'.
23
+
24
+SEE ALSO
25
+--------
26
+linkgit:git-remote-helpers[1]
27
+
28
+GIT
29
+---
30
+Part of the linkgit:git[1] suite
git-remote-testgit.py
+13
@@ -1,5 +1,18 @@
1
#!/usr/bin/env python
2
3
+# This command is a simple remote-helper, that is used both as a
4
+# testcase for the remote-helper functionality, and as an example to
5
+# show remote-helper authors one possible implementation.
6
+#
7
+# This is a Git <-> Git importer/exporter, that simply uses git
8
+# fast-import and git fast-export to consume and produce fast-import
9
+# streams.
10
+#
11
+# To understand better the way things work, one can activate debug
12
+# traces by setting (to any value) the environment variables
13
+# GIT_TRANSPORT_HELPER_DEBUG and GIT_DEBUG_TESTGIT, to see messages
14
+# from the transport-helper side, or from this example remote-helper.
15
+
16
# hashlib is only available in python >= 2.5
17
try:
18
import hashlib