Signed-off-by: Ramkumar Ramachandra <artagnon@xxxxxxxxx> --- Documentation/git-remote-helpers.txt | 22 ++++++++++++++++------ 1 files changed, 16 insertions(+), 6 deletions(-) diff --git a/Documentation/git-remote-helpers.txt b/Documentation/git-remote-helpers.txt index 1b5f61a..54b36c8 100644 --- a/Documentation/git-remote-helpers.txt +++ b/Documentation/git-remote-helpers.txt @@ -3,7 +3,8 @@ git-remote-helpers(1) NAME ---- -git-remote-helpers - Helper programs for interoperation with remote git +git-remote-helpers - Helper programs for interacting with main git +programs without linking to them SYNOPSIS -------- @@ -13,10 +14,19 @@ DESCRIPTION ----------- These programs are normally not used directly by end users, but are -invoked by various git programs that interact with remote repositories -when the repository they would operate on will be accessed using -transport code not linked into the main git binary. Various particular -helper programs will behave as documented here. +invoked by various git programs that interact with remote +repositories. For a program to qualify as a remote helper, it must +implement a subset of the capabilities documented here, and conform to +the remote helper protocol. Remote helpers interact with the main git +programs via text streams, and do not link to them. + +The curl helper is one such program. It is invoked via +'git-remote-http', 'git-remote-https', 'git-remote-ftp', or +'git-remote-ftps', and implments the capabilities 'fetch', 'option', +and 'push'. + +Remote helpers are often useful when native interoperability with a +foreign versioning system is desired. COMMANDS -------- @@ -122,7 +132,7 @@ CAPABILITIES This helper supports the 'fetch' command. 'option':: - This helper supports the option command. + This helper supports the 'option' command. 'push':: This helper supports the 'push' command. -- 1.7.0 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html