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

Re: [PATCH v2 2/8] string-list: remove unused "insert_at" parameter from add_entry

From
shejialuo <shejialuo@gmail.com>
Date
May 26, 2025, 14:01 UTC
Message-ID
<aDR0VS_4n8Io0QYp@ArchLinux>
In-Reply-To
<20250519075119.GE102701@coredump.intra.peff.net>
On Mon, May 19, 2025 at 03:51:19AM -0400, Jeff King wrote:
Show 18 quoted lines
> On Sun, May 18, 2025 at 11:57:07PM +0800, shejialuo wrote:
> 
> > In "add_entry", we accept "insert_at" parameter which must be either -1
> > (auto) or between 0 and `list->nr` inclusive. Any other value is
> > invalid. When caller specify any invalid "insert_at" value, we won't
> > check the range and move the element, which would definitely cause the
> > trouble.
> > 
> > However, we only use "add_entry" in "string_list_insert" function and we
> > always pass the "-1" for "insert_at" parameter. So, we never use this
> > parameter to insert element in a user specified position. Let's delete
> > this parameter. If there is any requirement later, we need to use a
> > better way to do this.
> 
> We can see from looking at the code that removing this will not change
> the behavior. But that always makes me wonder why it was there in the
> first place, and whether we might ever want it.
> 

Yes, I agree. Actually, in my first implementation, I didn't realise that this is redundant. However, when inspecting the code carefully, I find out this is useless.

Show 16 quoted lines
> The answer in this case is that we used to have another function,
> string_list_insert_at_index(), which used the extra insert_at parameter.
> The idea being that you could call string_list_find_insert_index(),
> decide whether there was something already there, and then insert
> without repeating the binary search.
> 
> But you can see in callers like 63226218ba (mailmap: use higher level
> string list functions, 2014-11-24) that this was not really that useful
> (in that commit we just try to insert and check the util pointer to see
> if we need to add the auxiliary structure).
> 
> So the function went away in f8c4ab611a (string_list: remove
> string_list_insert_at_index() from its API, 2014-11-24), and I suspect
> we won't need it again. (Also, I think these days we'd probably use a
> strmap instead anyway).
> 

Thanks for the hint. By seeing this commit, I totally understand the history. Because we delete `string_list_insert_at_index`, we simply call "add_entry" by specifying "auto" mode and somehow we don't delete the legacy check in "add_entry".

But I have one question: should I include the information in the commit message? I feel doing this would be chaty. But I somehow think we should do this.

Thanks, Jialuo

Previous: Jeff KingNext: Patrick Steinhardt
Message 24 of 52 in “enhance "string_list" code and test”
  1. 0/5 enhance "string_list" code and testshejialuo, Apr 22, 2025
  2. 1/5 string-list: fix sign compare warningsshejialuo, Apr 22, 2025
  3. Junio C HamanoApr 22, 2025
  4. shejialuoApr 24, 2025
  5. 2/5 u-string-list: move "test_split" into "u-string-list.c"shejialuo, Apr 22, 2025
  6. Junio C HamanoApr 22, 2025
  7. shejialuoApr 24, 2025
  8. Patrick SteinhardtApr 23, 2025
  9. shejialuoApr 24, 2025
  10. 3/5 u-string-list: move "test_split_in_place" to "u-string-list.c"shejialuo, Apr 22, 2025
  11. Patrick SteinhardtApr 23, 2025
  12. 4/5 u-string-list: move "filter string" test to "u-string-list.c"shejialuo, Apr 22, 2025
  13. 5/5 u-string-list: move "remove duplicates" test to "u-string-list.c"shejialuo, Apr 22, 2025
  14. Patrick SteinhardtApr 23, 2025
  15. shejialuoApr 24, 2025
  16. 0/8 enhance "string_list" code and testshejialuo, May 18, 2025
  17. 1/8 string-list: fix sign compare warnings for loop iteratorshejialuo, May 18, 2025
  18. Patrick SteinhardtMay 19, 2025
  19. shejialuoMay 26, 2025
  20. 2/8 string-list: remove unused "insert_at" parameter from add_entryshejialuo, May 18, 2025
  21. Patrick SteinhardtMay 19, 2025
  22. shejialuoMay 26, 2025
  23. Jeff KingMay 19, 2025
  24. shejialuoMay 26, 2025
  25. Patrick SteinhardtMay 26, 2025
  26. 3/8 string-list: return index directly when inserting an existing elementshejialuo, May 18, 2025
  27. Patrick SteinhardtMay 19, 2025
  28. shejialuoMay 26, 2025
  29. Jeff KingMay 19, 2025
  30. shejialuoMay 26, 2025
  31. 4/8 string-list: enable sign compare warnings checkshejialuo, May 18, 2025
  32. Patrick SteinhardtMay 19, 2025
  33. shejialuoMay 26, 2025
  34. 5/8 u-string-list: move "test_split" into "u-string-list.c"shejialuo, May 18, 2025
  35. Patrick SteinhardtMay 19, 2025
  36. 6/8 u-string-list: move "test_split_in_place" to "u-string-list.c"shejialuo, May 18, 2025
  37. 7/8 u-string-list: move "filter string" test to "u-string-list.c"shejialuo, May 18, 2025
  38. Patrick SteinhardtMay 19, 2025
  39. shejialuoMay 26, 2025
  40. 8/8 u-string-list: move "remove duplicates" test to "u-string-list.c"shejialuo, May 18, 2025
  41. Patrick SteinhardtMay 19, 2025
  42. 0/8 enhance "string_list" code and testshejialuo, Jun 29, 2025
  43. 1/8 string-list: fix sign compare warnings for loop iteratorshejialuo, Jun 29, 2025
  44. 2/8 string-list: remove unused "insert_at" parameter from add_entryshejialuo, Jun 29, 2025
  45. 3/8 string-list: return index directly when inserting an existing elementshejialuo, Jun 29, 2025
  46. 4/8 string-list: enable sign compare warnings checkshejialuo, Jun 29, 2025
  47. 5/8 u-string-list: move "test_split" into "u-string-list.c"shejialuo, Jun 29, 2025
  48. 6/8 u-string-list: move "test_split_in_place" to "u-string-list.c"shejialuo, Jun 29, 2025
  49. 7/8 u-string-list: move "filter string" test to "u-string-list.c"shejialuo, Jun 29, 2025
  50. 8/8 u-string-list: move "remove duplicates" test to "u-string-list.c"shejialuo, Jun 29, 2025
  51. Patrick SteinhardtJul 4, 2025
  52. Junio C HamanoJul 7, 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.