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

Re: [PATCH v5] generalizing sorted-array handling

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Dec 5, 2010, 10:44 UTC
Message-ID
<20101205104426.GG4332@burratino>
In-Reply-To
<1291545247-4151-1-git-send-email-ydirson@altern.org>
Yann Dirson wrote:
> * better API documentation (was previously lacking or plain obsolete)

Thanks! In general I find it is easiest to read and write documentation out of line for this sort of thing. That way, even after the documentation grows obsolete it doesn't seem so out of place.

See Documentation/technical/api-strbuf.txt, api-sigchain, and api-allocation-growing for some nice (up-to-date) examples.

In particular:
> * This API is very verbose, and I'm not happy with that aspect.
Could you give a quick stripped-down usage example?
[...]
> Adding "simple" API variants that would call all the necessary stuff
> would help code readability, but adding yet more entry points seems a
> dubious approach.

On the contrary, simple API variants don't sound so bad to me, once the fundamentals are in good shape.

Previous: Yann DirsonNext: Yann Dirson
Message 8 of 9 in “generalizing sorted-array handling”
  1. generalizing sorted-array handlingYann Dirson, Dec 5, 2010
  2. 1/6 Introduce sorted-array binary-search function.Yann Dirson, Dec 5, 2010
  3. 2/6 Convert diffcore-rename's rename_dst to the new sorted-array API.Yann Dirson, Dec 5, 2010
  4. 3/6 Convert diffcore-rename's rename_src to the new sorted-array API.Yann Dirson, Dec 5, 2010
  5. 4/6 Convert pack-objects.c to the new sorted-array API.Yann Dirson, Dec 5, 2010
  6. 5/6 Use sorted-array API for commit.c's commit_graft.Yann Dirson, Dec 5, 2010
  7. 6/6 [WIP] subvert sorted-array to replace binary-search in unpack-objects.Yann Dirson, Dec 5, 2010
  8. Jonathan NiederDec 5, 2010
  9. Yann DirsonDec 5, 2010

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.