Re: [PATCH 1/3] api-credential.txt: show the big picture first

[Jeff King <peff@peff.net>]

On Sun, Jun 03, 2012 at 06:10:02PM +0200, Matthieu Moy wrote:

> The API documentation targets two kinds of developers: those using the
> (C) API, and those writing remote-helpers. The document was not clear
> about which part was useful to which category, and for example, the C API
> could be mistakenly thought as an API for writting remote helpers.
> 
> Based-on-patch-by: Jeff King <peff@peff.net>
> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
> ---
> I took Jeff's explanation, but I insist in having a picture ;-).

Thanks. I had meant to follow-up, but it was among the least interesting
things for me to work on, so I procrastinated. And here I am being
rewarded for it with somebody else doing the work. :)

Looks good overall to me. Two minor comments:

> +The git code (typically a remote-helper) will call the C API to obtain
> +credential data like a login/password couple (credential_fill). The

I found the word "couple" odd here; I think "pair" would be more
idiomatic English.

> +API will itself call a remote helper (e.g. "git credential-cache" or
> +"git credential-store") that may retrieve credential data from a
> +store. If the credential helper cannot find the information, the C API
> +will prompt the user. Then, the caller of the API takes care of
> +contacting the server, and do the actual authentication.

s/do/does/

-Peff