{"thread":{"id":"23131","subject":"[PATCH v2] Improve remote-helpers documentation","startedAt":"2010-03-22T03:00:11Z","lastAt":"2010-03-22T03:00:11Z","messageCount":1,"participants":["Ramkumar Ramachandra"],"isPatch":true,"patchVersion":2,"patchTotal":null},"messages":[{"id":"137505","messageId":"f3271551003212000p6399516cp44527635c0f84cf@mail.gmail.com","threadId":"23131","inReplyTo":null,"subject":"[PATCH v2] Improve remote-helpers documentation","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-03-22T03:00:11Z","receivedAt":"2010-03-22T03:00:11Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>\n---\n Documentation/git-remote-helpers.txt |   24 ++++++++++++++++++------\n 1 files changed, 18 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/git-remote-helpers.txt\nb/Documentation/git-remote-helpers.txt\nindex 1b5f61a..97f301e 100644\n--- a/Documentation/git-remote-helpers.txt\n+++ b/Documentation/git-remote-helpers.txt\n@@ -3,7 +3,7 @@ git-remote-helpers(1)\n\n NAME\n ----\n-git-remote-helpers - Helper programs for interoperation with remote git\n+git-remote-helpers - Helper programs for interacting with main git\nwithout linking\n\n SYNOPSIS\n --------\n@@ -13,10 +13,22 @@ DESCRIPTION\n -----------\n\n These programs are normally not used directly by end users, but are\n-invoked by various git programs that interact with remote repositories\n-when the repository they would operate on will be accessed using\n-transport code not linked into the main git binary. Various particular\n-helper programs will behave as documented here.\n+invoked by various git programs that interact with remote\n+repositories.  For a program to qualify as a remote helper, it must\n+implement a subset of the capabilities documented here, and conform to\n+the remote helper protocol. Remote helpers interact with the main git\n+programs via text streams, and do not link to them.\n+\n+The curl helper is one such program. It is invoked via\n+'git-remote-http', 'git-remote-https', 'git-remote-ftp', or\n+'git-remote-ftps', and implments the capabilities 'fetch', 'option',\n+and 'push'. The curl helper essentially helps in moving around native\n+git objects.\n+\n+As opposed to native git objects, remote helpers can also provide a\n+fast-import stream through the 'import' capability. This makes it\n+especially useful when native interoperability with a foreign\n+versioning system is desired.\n\n COMMANDS\n --------\n@@ -122,7 +134,7 @@ CAPABILITIES\n \tThis helper supports the 'fetch' command.\n\n 'option'::\n-\tThis helper supports the option command.\n+\tThis helper supports the 'option' command.\n\n 'push'::\n \tThis helper supports the 'push' command.\n-- \n1.7.0\n"}]}