From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: Daniel Barkalow <barkalow@iabervon.org>,
Gabriel Filion <lelutin@gmail.com>,
Junio C Hamano <gitster@pobox.com>,
Sverre Rabbelier <srabbelier@gmail.com>,
Michael J Gruber <git@drmicha.warpmail.net>,
Git Mailing List <git@vger.kernel.org>,
Ilari Liusvaara <ilari.liusvaara@elisanet.fi>
Subject: [PATCH v3] Documentation/remote-helpers: Add invocation section
Date: Wed, 31 Mar 2010 00:48:44 +0530 [thread overview]
Message-ID: <f3271551003301218k4828c44id700b4865001baf9@mail.gmail.com> (raw)
Add an invocation section to specify what the command line arguments
mean. Also include a link to git-remote in the see also section.
---
What changed since v2: Explained the meaning of ambiguity, and
improved overall clarity.
Documentation/git-remote-helpers.txt | 17 +++++++++++++++++
1 files changed, 17 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-remote-helpers.txt
b/Documentation/git-remote-helpers.txt
index 2382fb4..4375678 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -38,6 +38,17 @@ Git comes with a "curl" family of remote helpers,
specifically
'git-remote-ftps'. They implement the capabilities 'fetch', 'option',
and 'push'.
+INVOCATION
+----------
+
+Remote helper programs are invoked with one or (optionally) two
+command line arguments. The first argument specifies a remote
+repository as it would be in git; typically, it is either the name of
+a configured remote or just a URL. The second argument, if present, is
+a URL, and serves to resolve ambiguities that may arise when only the
+first argument is specified (i.e. when a remote has more than one
+configured URL).
+
COMMANDS
--------
@@ -206,6 +217,12 @@ OPTIONS
must not rely on this option being set before
connect request occurs.
+
+SEE ALSO
+--------
+linkgit:git-remote[1]
+
+
Documentation
-------------
Documentation by Daniel Barkalow and Ilari Liusvaara
--
1.7.0.3
next reply other threads:[~2010-03-30 19:26 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-03-30 19:18 Ramkumar Ramachandra [this message]
2010-03-30 19:28 ` [PATCH v3] Documentation/remote-helpers: Add invocation section Ramkumar Ramachandra
2010-03-30 19:50 ` Jonathan Nieder
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=f3271551003301218k4828c44id700b4865001baf9@mail.gmail.com \
--to=artagnon@gmail.com \
--cc=barkalow@iabervon.org \
--cc=git@drmicha.warpmail.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=ilari.liusvaara@elisanet.fi \
--cc=jrnieder@gmail.com \
--cc=lelutin@gmail.com \
--cc=srabbelier@gmail.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).