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, 18:47 UTC
Message-ID
<20250802184715.GD1773585@coredump.intra.peff.net>
In-Reply-To
<xmqq4iupira0.fsf@gitster.g>
On Sat, Aug 02, 2025 at 10:09:59AM -0700, Junio C Hamano wrote:
Show 10 quoted lines
> >   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.
> 
> Same between?  strbuf_split*() seems to be happy to produce an empty
> piece in the result (and there is no "omit empty ones" feature).
> You can choose with STRING_LIST_SPLIT_NOEMPTY both results, but for
> a straight conversion, the vanilla one without that flag would do
> what we want, I think.

Yeah, I meant same between strbuf_split and string_list_split. I didn't actually peek into the behavior of either. It was more of a "did you check this it?" question. It sounds like you did. Good.

Show 16 quoted lines
> > 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).
> 
> I did wonder about these "rtrim-only" callsites strbuf_split(), but
> I did not think they needed ltrim, since they were splitting at SP
> and rejected when the element were empty (remember, strbuf_split()
> happily creates an empty element in the result).
> 
> Their use of rtrim() is primarily when they split at SP they want to
> remove that SP (remember, another misdesign of strbuf_split() is
> that it leaves the delimiter itself at the end of each split piece).
> Both 05/11 step for merge-tree and 06/11 step for notes are good
> examples.

Makes sense. I did not even realize all of the horrible gotchas of strbuf_split(). :)

Show 10 quoted lines
> So in short, yes, the new code is being a bit more lenient (the
> original parsers were more strict and insisted on non-trimming
> behaviour).  We might consider tightening them by removing the
> STRING_LIST_SPLIT_TRIM bit to be more faithful to the original, but
> as you may have noticed, doing so would make it more strict at the
> right end.  The original that split at SP and then rtrimmed allowed
> trailing HT after the data to be removed, but I do not think it was
> part of the designed behaviour of the original anyway.  So I am
> inclined to say we should probably drop STRING_LIST_SPLIT_TRIM;
> nobody would scream.

Hmm, yeah, I see what you mean. The documentation for merge-tree is quite vague about whether it is a single space or if multiple spaces are allowed. I'd be inclined to leave it on the lenient side, since I don't think there is any ambiguity.

The git-notes one does specifically say "SP", so anybody who would be broken by losing the extra trim is already violating the docs. But again, I'd be tempted to just err on the friendly side.

I doubt either case matters too much either way, though.
-Peff
Previous: Junio C Hamano
Message 33 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.