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

Re: [PATCH v2 00/11] do not overuse strbuf_split*()

From
Jeff King <peff@peff.net>
Date
Aug 2, 2025, 09:08 UTC
Message-ID
<20250802090825.GE3711639@coredump.intra.peff.net>
In-Reply-To
<20250731225433.4028872-1-gitster@pobox.com>
On Thu, Jul 31, 2025 at 03:54:22PM -0700, Junio C Hamano wrote:
Show 7 quoted lines
> strbuf is a very good data structure to work with string data
> without having to worry about running past the end of the string.
> 
> But an array of strbuf is often a wrong data structure.  You rarely
> have need to be able to edit multiple strings represented by such an
> array simultaneously.  And strbuf_split*() that produces result in
> such a shape is a misdesigned API function.

Yeah, I agree it's a bad API, and I'd be happy if we could eventually get rid of it.

Conversion to string_list mostly makes sense (though I especially like the case in sub-process.c where we can just parse with skip_prefix()).

I looked over the patches and didn't see anything objectionable. But I tried to think of subtle incompatibilities we might run into:

  1. I saw the different handling of "max" you had to deal with in one
     patch. Yuck. It might be worth tweaking string_list_split() to
     count "pieces" (which is how every other split function I've seen,
     like the one in perl, works). But that can be done later (and is
     tricky to do safely, since we wouldn't be changing the function
     signature).
  2. Is the handling of repeated delimiters the same? E.g., if I split
     on "/" and we see "foo//bar", do both split implementations yield
     the same output. I could see either of ("foo", "", "bar") and
     ("foo", "bar") being produced.
And...
> The most common use case of strbuf_split*() family of functions
> seems to be to trim away the whitespaces around each piece of split
> string.  With modern string_list_split*(), it is often no longer
> necessary.

Some of these sites do strbuf_rtrim() on the split pieces. But STRING_LIST_SPLIT_TRIM does both left and right. Is this OK? I think so because in both cases we are already splitting on space, so we wouldn't expect left-hand spaces (of course you could have a stray tab or something, but I suspect the new code matches the intent more closely).

-Peff
Previous: Junio C HamanoNext: Junio C Hamano
Message 31 of 33 in “do not overuse strbuf_split*()”
  1. 0/9 do not overuse strbuf_split*()Junio C Hamano, Jul 31, 2025
  2. 1/9 wt-status: avoid strbuf_split*()Junio C Hamano, Jul 31, 2025
  3. 2/9 clean: do not pass strbuf by valueJunio C Hamano, Jul 31, 2025
  4. 3/9 clean: do not use strbuf_split*() [part 1]Junio C Hamano, Jul 31, 2025
  5. 4/9 clean: do not use strbuf_split*() [part 2]Junio C Hamano, Jul 31, 2025
  6. 5/9 merge-tree: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  7. 6/9 notes: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  8. Eric SunshineJul 31, 2025
  9. 7/9 config: do not use strbuf_split()Junio C Hamano, Jul 31, 2025
  10. Eric SunshineJul 31, 2025
  11. 8/9 environment: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  12. 9/9 sub-process: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  13. Christian CouderJul 31, 2025
  14. Junio C HamanoJul 31, 2025
  15. 00/11 do not overuse strbuf_split*()Junio C Hamano, Jul 31, 2025
  16. 01/11 wt-status: avoid strbuf_split*()Junio C Hamano, Jul 31, 2025
  17. 02/11 clean: do not pass strbuf by valueJunio C Hamano, Jul 31, 2025
  18. Jeff KingAug 2, 2025
  19. Junio C HamanoAug 2, 2025
  20. Jeff KingAug 2, 2025
  21. 03/11 clean: do not use strbuf_split*() [part 1]Junio C Hamano, Jul 31, 2025
  22. 04/11 clean: do not use strbuf_split*() [part 2]Junio C Hamano, Jul 31, 2025
  23. 05/11 merge-tree: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  24. Jeff KingAug 2, 2025
  25. 06/11 notes: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  26. 07/11 config: do not use strbuf_split()Junio C Hamano, Jul 31, 2025
  27. 08/11 environment: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  28. 09/11 sub-process: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  29. 10/11 trace2: trim_trailing_newline followed by trim is a no-opJunio C Hamano, Jul 31, 2025
  30. 11/11 trace2: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  31. Jeff KingAug 2, 2025
  32. Junio C HamanoAug 2, 2025
  33. Jeff KingAug 2, 2025

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.