From: Matthieu Moy <Matthieu.Moy@imag.fr>
To: git@vger.kernel.org, gitster@pobox.com
Cc: Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: [PATCH] (short) documentation for the testgit remote helper
Date: Wed, 31 Aug 2011 20:14:58 +0200 [thread overview]
Message-ID: <1314814498-13699-1-git-send-email-Matthieu.Moy@imag.fr> (raw)
In-Reply-To: <1314809222-30528-1-git-send-email-Matthieu.Moy@imag.fr>
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>
---
While we're improving the docs, this is one more thing that would have
saved me some time ...
Documentation/git-remote-helpers.txt | 2 ++
Documentation/git-remote-testgit.txt | 30 ++++++++++++++++++++++++++++++
git-remote-testgit.py | 14 ++++++++++++++
3 files changed, 46 insertions(+), 0 deletions(-)
create mode 100644 Documentation/git-remote-testgit.txt
diff --git a/Documentation/git-remote-helpers.txt b/Documentation/git-remote-helpers.txt
index 526fc6a..674797c 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -362,6 +362,8 @@ SEE ALSO
--------
linkgit:git-remote[1]
+linkgit:git-remote-testgit[1]
+
GIT
---
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
index 0000000..2a67d45
--- /dev/null
+++ b/Documentation/git-remote-testgit.txt
@@ -0,0 +1,30 @@
+git-remote-testgit(1)
+=====================
+
+NAME
+----
+git-remote-testgit - Example remote-helper
+
+
+SYNOPSIS
+--------
+[verse]
+git clone testgit::<source-repo> [<destination>]
+
+DESCRIPTION
+-----------
+
+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
+'git-remote-testgit.py'.
+
+SEE ALSO
+--------
+linkgit:git-remote-helpers[1]
+
+GIT
+---
+Part of the linkgit:git[1] suite
diff --git a/git-remote-testgit.py b/git-remote-testgit.py
index e9c832b..91d4409 100644
--- a/git-remote-testgit.py
+++ b/git-remote-testgit.py
@@ -1,5 +1,19 @@
#!/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 set the variable
+# "static int debug" in transport-helper.c to 1, and/or the "DEBUG"
+# variable in git_remote_helpers/util.py to True, and try various
+# commands.
+
+
# hashlib is only available in python >= 2.5
try:
import hashlib
--
1.7.7.rc0.75.g56f27
next prev parent reply other threads:[~2011-08-31 18:15 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-08-26 17:11 [PATCH 1/2] fast-import: initialize variable require_explicit_termination Matthieu Moy
2011-08-26 17:11 ` [PATCH 2/2] Add a remote helper to interact with mediawiki (fetch & push) Matthieu Moy
2011-08-26 17:53 ` Junio C Hamano
2011-08-29 5:42 ` Sverre Rabbelier
2011-08-29 6:05 ` Junio C Hamano
2011-08-29 6:41 ` Sverre Rabbelier
2011-08-30 3:56 ` Jonathan Nieder
2011-08-30 17:13 ` Junio C Hamano
2011-08-31 11:54 ` Matthieu Moy
2011-09-01 23:44 ` Jonathan Nieder
2011-08-31 12:05 ` done feature in remote-helpers (was Re: [PATCH 2/2] Add a remote helper to interact with mediawiki (fetch & push)) Matthieu Moy
2011-08-31 12:17 ` Sverre Rabbelier
2011-08-31 12:55 ` Matthieu Moy
2011-08-31 12:58 ` Sverre Rabbelier
2011-08-31 13:12 ` Matthieu Moy
2011-08-31 13:16 ` Sverre Rabbelier
2011-08-31 16:47 ` [PATCH] git-remote-helpers.txt: explain how import works with multiple refs Matthieu Moy
2011-08-31 18:14 ` Matthieu Moy [this message]
2011-09-01 11:27 ` [PATCH] (short) documentation for the testgit remote helper Sverre Rabbelier
2011-09-01 15:52 ` Matthieu Moy
2011-09-01 16:49 ` [PATCH 1/2 v2] Documentation/git-remote-helpers: explain how import works with multiple refs Matthieu Moy
2011-09-01 16:49 ` [PATCH 2/2 v2] (short) documentation for the testgit remote helper Matthieu Moy
2011-09-01 16:59 ` Sverre Rabbelier
2011-09-01 16:59 ` [PATCH 1/2 v2] Documentation/git-remote-helpers: explain how import works with multiple refs Sverre Rabbelier
2011-09-01 11:24 ` [PATCH] git-remote-helpers.txt: " Sverre Rabbelier
2011-09-01 23:17 ` Jonathan Nieder
2011-09-03 10:35 ` Matthieu Moy
2011-08-26 17:55 ` [PATCH v5] Add a remote helper to interact with mediawiki (fetch & push) Matthieu Moy
2011-08-31 16:55 ` [PATCH v6] " Matthieu Moy
2011-08-31 17:03 ` Sverre Rabbelier
2011-08-31 17:30 ` Matthieu Moy
2011-09-01 0:24 ` Junio C Hamano
2011-09-01 5:26 ` Matthieu Moy
2011-09-01 16:54 ` [PATCH 0/2] Git-MediaWiki Matthieu Moy
2011-09-01 16:54 ` [PATCH 1/2 v7] Add a remote helper to interact with mediawiki (fetch & push) Matthieu Moy
2011-09-01 16:54 ` [PATCH 2/2] git-remote-mediawiki: allow push to set MediaWiki metadata Matthieu Moy
2011-08-31 12:33 ` Clean termination of remote-helpers (was Re: [PATCH 2/2] Add a remote helper to interact with mediawiki (fetch & push)) Matthieu Moy
2011-08-31 13:25 ` Sverre Rabbelier
2011-08-31 14:53 ` Matthieu Moy
2011-08-31 15:00 ` Sverre Rabbelier
2011-08-26 17:51 ` [PATCH 1/2] fast-import: initialize variable require_explicit_termination Junio C Hamano
2011-08-26 17:59 ` Matthieu Moy
2011-08-26 18:55 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1314814498-13699-1-git-send-email-Matthieu.Moy@imag.fr \
--to=matthieu.moy@imag.fr \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).