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

Re: [PATCH v2 7/8] trailer: make trailer_info struct private

From
LALinus Arver <linusa@google.com>
Date
Apr 25, 2024, 03:17 UTC
Message-ID
<owlyzfti3zc4.fsf@fine.c.googlers.com>
In-Reply-To
<xmqq34rb64oj.fsf@gitster.g>
Junio C Hamano <gitster@pobox.com> writes:
Show 21 quoted lines
> "Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> There are a couple disadvantages:
>>
>>   (A) every time the member of the struct is accessed an extra pointer
>>       dereference must be done, and
>>
>>   (B) for users of trailer_info outside trailer.c, this struct can no
>>       longer be allocated on the stack and may only be allocated on the
>>       heap (because its definition is hidden away in trailer.c) and
>>       appropriately deallocated by the user.
>
>     (C) without good documentation on the API, the opaque struct is
>         hostile to programmers by going opposite to "Show me your
>         data structures, and I won't usually need your code; it'll
>         be obvious." mantra.
>
> The comment inside trailer.c does not count (the API users are not
> supposed to peek in it---that's the whole point of making the
> structure opaque).  You'd need to compensate with a bit more doc in
> trailer.h to help the API users.

SGTM. I can reroll again by the end of the week to add docs for would-be API users. Cheers

Previous: Junio C HamanoNext: Linus Arver via GitGitGadget
Message 24 of 66 in “Make trailer_info struct private (plus sequencer cleanup)”
  1. 0/6 Make trailer_info struct private (plus sequencer cleanup)Linus Arver via GitGitGadget, Mar 16, 2024
  2. 1/6 trailer: teach iterator about non-trailer linesLinus Arver via GitGitGadget, Mar 16, 2024
  3. 2/6 sequencer: use the trailer iteratorLinus Arver via GitGitGadget, Mar 16, 2024
  4. 3/6 interpret-trailers: access trailer_info with new helpersLinus Arver via GitGitGadget, Mar 16, 2024
  5. 4/6 trailer: make parse_trailers() return trailer_info pointerLinus Arver via GitGitGadget, Mar 16, 2024
  6. 5/6 trailer: make trailer_info struct privateLinus Arver via GitGitGadget, Mar 16, 2024
  7. 6/6 trailer: retire trailer_info_get() from APILinus Arver via GitGitGadget, Mar 16, 2024
  8. Junio C HamanoMar 16, 2024
  9. Junio C HamanoMar 26, 2024
  10. Linus ArverApr 19, 2024
  11. 0/8 Make trailer_info struct private (plus sequencer cleanup)Linus Arver via GitGitGadget, Apr 19, 2024
  12. 1/8 Makefile: sort UNIT_TEST_PROGRAMSLinus Arver via GitGitGadget, Apr 19, 2024
  13. 2/8 trailer: add unit tests for trailer iteratorLinus Arver via GitGitGadget, Apr 19, 2024
  14. Linus ArverApr 19, 2024
  15. Linus ArverApr 19, 2024
  16. Junio C HamanoApr 19, 2024
  17. Linus ArverApr 20, 2024
  18. 3/8 trailer: teach iterator about non-trailer linesLinus Arver via GitGitGadget, Apr 19, 2024
  19. 4/8 sequencer: use the trailer iteratorLinus Arver via GitGitGadget, Apr 19, 2024
  20. Junio C HamanoApr 23, 2024
  21. 5/8 interpret-trailers: access trailer_info with new helpersLinus Arver via GitGitGadget, Apr 19, 2024
  22. 7/8 trailer: make trailer_info struct privateLinus Arver via GitGitGadget, Apr 19, 2024
  23. Junio C HamanoApr 23, 2024
  24. Linus ArverApr 25, 2024
  25. 6/8 trailer: make parse_trailers() return trailer_info pointerLinus Arver via GitGitGadget, Apr 19, 2024
  26. Junio C HamanoApr 23, 2024
  27. 8/8 trailer: retire trailer_info_get() from APILinus Arver via GitGitGadget, Apr 19, 2024
  28. Junio C HamanoApr 23, 2024
  29. Junio C HamanoApr 24, 2024
  30. 00/10 Make trailer_info struct private (plus sequencer cleanup)Linus Arver via GitGitGadget, Apr 26, 2024
  31. 01/10 Makefile: sort UNIT_TEST_PROGRAMSLinus Arver via GitGitGadget, Apr 26, 2024
  32. 02/10 trailer: add unit tests for trailer iteratorLinus Arver via GitGitGadget, Apr 26, 2024
  33. Christian CouderApr 26, 2024
  34. Junio C HamanoApr 26, 2024
  35. Linus ArverApr 26, 2024
  36. 03/10 trailer: teach iterator about non-trailer linesLinus Arver via GitGitGadget, Apr 26, 2024
  37. Christian CouderApr 27, 2024
  38. Linus ArverApr 30, 2024
  39. Linus ArverApr 30, 2024
  40. 04/10 sequencer: use the trailer iteratorLinus Arver via GitGitGadget, Apr 26, 2024
  41. 05/10 interpret-trailers: access trailer_info with new helpersLinus Arver via GitGitGadget, Apr 26, 2024
  42. 06/10 trailer: make parse_trailers() return trailer_info pointerLinus Arver via GitGitGadget, Apr 26, 2024
  43. 07/10 trailer: make trailer_info struct privateLinus Arver via GitGitGadget, Apr 26, 2024
  44. 08/10 trailer: retire trailer_info_get() from APILinus Arver via GitGitGadget, Apr 26, 2024
  45. 10/10 trailer unit tests: inspect iterator contentsLinus Arver via GitGitGadget, Apr 26, 2024
  46. 09/10 trailer: document parse_trailers() usageLinus Arver via GitGitGadget, Apr 26, 2024
  47. Christian CouderApr 27, 2024
  48. 00/10 Make trailer_info struct private (plus sequencer cleanup)Linus Arver via GitGitGadget, May 2, 2024
  49. 01/10 Makefile: sort UNIT_TEST_PROGRAMSLinus Arver via GitGitGadget, May 2, 2024
  50. 02/10 trailer: add unit tests for trailer iteratorLinus Arver via GitGitGadget, May 2, 2024
  51. Junio C HamanoMay 2, 2024
  52. 03/10 trailer: teach iterator about non-trailer linesLinus Arver via GitGitGadget, May 2, 2024
  53. Phillip WoodMay 4, 2024
  54. Linus ArverMay 5, 2024
  55. Phillip WoodMay 5, 2024
  56. Linus ArverMay 9, 2024
  57. Phillip WoodMay 13, 2024
  58. Phillip WoodMay 13, 2024
  59. 04/10 sequencer: use the trailer iteratorLinus Arver via GitGitGadget, May 2, 2024
  60. 05/10 interpret-trailers: access trailer_info with new helpersLinus Arver via GitGitGadget, May 2, 2024
  61. 06/10 trailer: make parse_trailers() return trailer_info pointerLinus Arver via GitGitGadget, May 2, 2024
  62. 07/10 trailer: make trailer_info struct privateLinus Arver via GitGitGadget, May 2, 2024
  63. 08/10 trailer: retire trailer_info_get() from APILinus Arver via GitGitGadget, May 2, 2024
  64. 09/10 trailer: document parse_trailers() usageLinus Arver via GitGitGadget, May 2, 2024
  65. 10/10 trailer unit tests: inspect iterator contentsLinus Arver via GitGitGadget, May 2, 2024
  66. Junio C HamanoMay 2, 2024

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.