[PATCH 2/2] Documentation/remote-helpers: Clarify "curl" family of remote helpers

[PATCH 2/2] Documentation/remote-helpers: Clarify "curl" family of remote helpers

[Ramkumar Ramachandra]

Rewrite paragraph about "curl" family of remote helpers to clarify
different invocations of the same program.
---
 Documentation/git-remote-helpers.txt |    7 +++----
 1 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-remote-helpers.txt
b/Documentation/git-remote-helpers.txt
index 58533e5..f1fc736 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -33,10 +33,9 @@ reachable via those refs to local, and update the
local object
 store. Using the 'push' capability, they can transfer objects from
 local to remote, and update the corresponding refs as necessary.

-Git comes with a "curl" family of remote helpers, specifically
-'git-remote-http', 'git-remote-https', 'git-remote-ftp' and
-'git-remote-ftps'. They implement the capabilities 'fetch', 'option',
-and 'push'.
+Git comes with a "curl" remote helper, which can be invoked as
+'git-remote-http', 'git-remote-https', 'git-remote-ftp' or
+'git-remote-ftps'. See INVOCATION below.

 INVOCATION
 ----------
-- 
1.7.0.3

Re: [PATCH 2/2] Documentation/remote-helpers: Clarify "curl" family of remote helpers

[Junio C Hamano]

Ramkumar Ramachandra <artagnon@gmail.com> writes:

> Rewrite paragraph about "curl" family of remote helpers to clarify
> different invocations of the same program.

I don't see anything wrong with "curl family".  Individually they may be
http, https, etc. remote helper, but if you need a name to collectively
call them, you would want to say "curl family of helpers"; "curl helpers"
simply doesn't make sense.

If you want to just say "we ship multiple", we could also say "a family of
helpers" as well.  "curl"-ness is an implementation detail.

Re: [PATCH 2/2] Documentation/remote-helpers: Clarify "curl" family of remote helpers

[Ramkumar Ramachandra]

Hi,

> I don't see anything wrong with "curl family".  Individually they may be
> http, https, etc. remote helper, but if you need a name to collectively
> call them, you would want to say "curl family of helpers"; "curl helpers"
> simply doesn't make sense.

Okay. Since this depends on the corresponding PATCH 1/2, which is
currently under debate, I suggest that we drop this patch. Yes, the
older version of the paragraph slightly confusing as Tay pointed out,
but I don't know how to make it any clearer without getting into
invocation details.

-- Ram