git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Jeff King <peff@peff.net>
Date
Jun 4, 2012, 11:51 UTC
Message-ID
<20120604115108.GA27676@sigill.intra.peff.net>
In-Reply-To
<1338739804-32167-2-git-send-email-Matthieu.Moy@imag.fr>
On Sun, Jun 03, 2012 at 06:10:02PM +0200, Matthieu Moy wrote:
Show 9 quoted lines
> 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.

Show 5 quoted lines
> +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
Previous: Matthieu MoyNext: Matthieu Moy
Message 3 of 24 in “Improve credential API documentation”
  1. 0/3 Improve credential API documentationMatthieu Moy, Jun 3, 2012
  2. 1/3 api-credential.txt: show the big picture firstMatthieu Moy, Jun 3, 2012
  3. Jeff KingJun 4, 2012
  4. 2/3 api-credentials.txt: mention credential.helper explicitlyMatthieu Moy, Jun 3, 2012
  5. Jeff KingJun 4, 2012
  6. Matthieu MoyJun 4, 2012
  7. 3/3 api-credentials.txt: add "see also" sectionMatthieu Moy, Jun 3, 2012
  8. Junio C HamanoJun 3, 2012
  9. Matthieu MoyJun 4, 2012
  10. Jeff KingJun 4, 2012
  11. Junio C HamanoJun 4, 2012
  12. Matthieu MoyJun 4, 2012
  13. Jeff KingJun 5, 2012
  14. Jeff KingJun 5, 2012
  15. Matthieu MoyJun 5, 2012
  16. Jeff KingJun 5, 2012
  17. Junio C HamanoJun 5, 2012
  18. Jeff KingJun 5, 2012
  19. Junio C HamanoJun 5, 2012
  20. 1/4 doc: fix xref link from api docs to manual pagesMatthieu Moy, Jun 4, 2012
  21. 2/4 api-credential.txt: show the big picture firstMatthieu Moy, Jun 4, 2012
  22. Jeff KingJun 5, 2012
  23. 3/4 api-credentials.txt: mention credential.helper explicitlyMatthieu Moy, Jun 4, 2012
  24. 4/4 api-credentials.txt: add "see also" sectionMatthieu Moy, Jun 4, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.