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

Re: [PATCH v4 2/6] commit: add amend suboption to --fixup to create amend! commit

From
Charvi Mendiratta <charvi077@gmail.com>
Date
Mar 11, 2021, 17:51 UTC
Message-ID
<CAPSFM5fc_TtSxFkLvMSN3sX18TLq9ijUQ0Aw8z0P+OG=BMGwqQ@mail.gmail.com>
In-Reply-To
<CAPig+cTBXBjZkJoGFYpzWBnEOmV52dnoBHxceuoe3pu3F0BnYw@mail.gmail.com>
On Thu, 11 Mar 2021 at 22:38, Eric Sunshine <sunshine@sunshineco.com> wrote:
Show 50 quoted lines
>
> On Thu, Mar 11, 2021 at 10:24 AM Charvi Mendiratta <charvi077@gmail.com> wrote:
> > On Thu, 11 Mar 2021 at 11:55, Eric Sunshine <sunshine@sunshineco.com> wrote:
> > > > +               size_t len = get_alpha_len(fixup_message);
> > > > +               if (len && fixup_message[len] == ':') {
> > > > +                       fixup_message[len++] = '\0';
> > > > +                       fixup_commit = fixup_message + len;
> > >
> > > An alternate -- just about as compact and perhaps more idiomatic --
> > > way to write all this without introducing the new get_alpha_len()
> > > function:
> > >
> > >     char *p = fixup_mesage;
> > >     while (isalpha(*p))
> > >         p++;
> > >     if (p > fixup_message && *p == ':') {
> > >         *p = '\0';
> > >         fixup_commit = p + 1;
> >
> > Earlier we had discussed[1] keeping a separate helper function, so
> > that it may re-use it later. But I agree above is easier to get and
> > compact so I think maybe it will be ok, for this patch series to
> > replace it with the above and remove the function.
>
> I don't have strong feelings one way or the other whether you should
> use a function or inline it as I showed above, and since our aim is to
> land this series rather than endlessly re-rolling it, let's not spend
> a lot of cycles worrying about it.
>
> The one thing that does bother me, however, is the name of the
> function, get_alpha_len(), which tells you (somewhat) literally what
> it does but doesn't convey to the reader its actual purpose (which is
> something we should strive for when naming functions and variables).
> In that previous discussion you referenced, Junio mentioned that a
> future sub-option might want to have punctuation in its name. If that
> ever comes about, then the name get_alpha_len() no longer makes sense
> and needs to be renamed so it doesn't become a lie. Giving the
> function a better name up front would not only help readers now to
> understand what is going on, but would also help down the road when or
> if punctuation (or numbers or whatnot) become valid in a sub-option
> name. suboption_length() is one possibility. With a slight semantic
> change, skip_suboption() or latch_suboption() are other possibilities.
> Or, if you were to open-code the loop as I did above, then you might
> have a function named is_suboption_char() and use that in place of
> isalpha().
>
> So, if you do re-roll, I wouldn't mind seeing a better name for the
> function; but the rest is subjective and not worth spending time
> refining unless you actually feel that one style has a clear advantage
> over others.
Okay, I will rename the get_alpha_len() to skip_suboption().

Thanks and Regards, Charvi

Previous: Eric SunshineNext: Junio C Hamano
Message 74 of 95 in “[Outreachy] commit: Implementation of "amend!" commit”
  1. 0/6 [Outreachy] commit: Implementation of "amend!" commitCharvi Mendiratta, Mar 1, 2021
  2. 2/6 commit: add amend suboption to --fixup to create amend! commitCharvi Mendiratta, Mar 1, 2021
  3. Junio C HamanoMar 1, 2021
  4. Charvi MendirattaMar 3, 2021
  5. Eric SunshineMar 1, 2021
  6. Junio C HamanoMar 1, 2021
  7. Eric SunshineMar 1, 2021
  8. Charvi MendirattaMar 3, 2021
  9. Charvi MendirattaMar 3, 2021
  10. Eric SunshineMar 3, 2021
  11. Charvi MendirattaMar 3, 2021
  12. Junio C HamanoMar 4, 2021
  13. Charvi MendirattaMar 4, 2021
  14. Charvi MendirattaMar 3, 2021
  15. Eric SunshineMar 3, 2021
  16. Charvi MendirattaMar 3, 2021
  17. 1/6 sequencer: export subject_length()Charvi Mendiratta, Mar 1, 2021
  18. Eric SunshineMar 1, 2021
  19. Junio C HamanoMar 3, 2021
  20. Charvi MendirattaMar 3, 2021
  21. 5/6 t3437: use --fixup with options to create amend! commitCharvi Mendiratta, Mar 1, 2021
  22. 4/6 t7500: add tests for --fixup=[amend|reword] optionsCharvi Mendiratta, Mar 1, 2021
  23. Eric SunshineMar 2, 2021
  24. Junio C HamanoMar 3, 2021
  25. Charvi MendirattaMar 3, 2021
  26. 3/6 commit: add a reword suboption to --fixupCharvi Mendiratta, Mar 1, 2021
  27. Junio C HamanoMar 1, 2021
  28. Charvi MendirattaMar 3, 2021
  29. Eric SunshineMar 1, 2021
  30. Charvi MendirattaMar 3, 2021
  31. 6/6 doc/git-commit: add documentation for fixup=[amend|reword] optionsCharvi Mendiratta, Mar 1, 2021
  32. Junio C HamanoMar 1, 2021
  33. Charvi MendirattaMar 3, 2021
  34. Eric SunshineMar 2, 2021
  35. Charvi MendirattaMar 3, 2021
  36. Eric SunshineMar 3, 2021
  37. Charvi MendirattaMar 3, 2021
  38. Junio C HamanoMar 4, 2021
  39. Charvi MendirattaMar 4, 2021
  40. Junio C HamanoMar 4, 2021
  41. Charvi MendirattaMar 5, 2021
  42. Junio C HamanoMar 5, 2021
  43. Charvi MendirattaMar 6, 2021
  44. Eric SunshineMar 6, 2021
  45. Junio C HamanoMar 1, 2021
  46. Charvi MendirattaMar 3, 2021
  47. 0/6 [Outreachy] commit: Implementation of "amend!" commitCharvi Mendiratta, Mar 10, 2021
  48. Eric SunshineMar 11, 2021
  49. Charvi MendirattaMar 11, 2021
  50. 3/6 commit: add a reword suboption to --fixupCharvi Mendiratta, Mar 13, 2021
  51. 0/6 [Outreachy] commit: Implementation of "amend!" commitCharvi Mendiratta, Mar 13, 2021
  52. 2/6 commit: add amend suboption to --fixup to create amend! commitCharvi Mendiratta, Mar 13, 2021
  53. Eric SunshineMar 14, 2021
  54. 1/6 sequencer: export and rename subject_length()Charvi Mendiratta, Mar 13, 2021
  55. 4/6 t7500: add tests for --fixup=[amend|reword] optionsCharvi Mendiratta, Mar 13, 2021
  56. 5/6 t3437: use --fixup with options to create amend! commitCharvi Mendiratta, Mar 13, 2021
  57. 6/6 doc/git-commit: add documentation for fixup=[amend|reword] optionsCharvi Mendiratta, Mar 13, 2021
  58. Eric SunshineMar 14, 2021
  59. Charvi MendirattaMar 14, 2021
  60. 0/6 [Outreachy] commit: Implementation of "amend!" commitCharvi Mendiratta, Mar 15, 2021
  61. Junio C HamanoMar 19, 2021
  62. Eric SunshineMar 19, 2021
  63. Charvi MendirattaMar 19, 2021
  64. 1/6 sequencer: export and rename subject_length()Charvi Mendiratta, Mar 15, 2021
  65. 3/6 commit: add a reword suboption to --fixupCharvi Mendiratta, Mar 15, 2021
  66. 2/6 commit: add amend suboption to --fixup to create amend! commitCharvi Mendiratta, Mar 15, 2021
  67. 4/6 t7500: add tests for --fixup=[amend|reword] optionsCharvi Mendiratta, Mar 15, 2021
  68. 6/6 doc/git-commit: add documentation for fixup=[amend|reword] optionsCharvi Mendiratta, Mar 15, 2021
  69. 5/6 t3437: use --fixup with options to create amend! commitCharvi Mendiratta, Mar 15, 2021
  70. 2/6 commit: add amend suboption to --fixup to create amend! commitCharvi Mendiratta, Mar 10, 2021
  71. Eric SunshineMar 11, 2021
  72. Charvi MendirattaMar 11, 2021
  73. Eric SunshineMar 11, 2021
  74. Charvi MendirattaMar 11, 2021
  75. Junio C HamanoMar 14, 2021
  76. Charvi MendirattaMar 14, 2021
  77. Junio C HamanoMar 14, 2021
  78. Eric SunshineMar 14, 2021
  79. Charvi MendirattaMar 15, 2021
  80. Eric SunshineMar 15, 2021
  81. Charvi MendirattaMar 15, 2021
  82. 1/6 sequencer: export and rename subject_length()Charvi Mendiratta, Mar 10, 2021
  83. 3/6 commit: add a reword suboption to --fixupCharvi Mendiratta, Mar 10, 2021
  84. Junio C HamanoMar 11, 2021
  85. Charvi MendirattaMar 11, 2021
  86. Junio C HamanoMar 11, 2021
  87. Eric SunshineMar 11, 2021
  88. Charvi MendirattaMar 11, 2021
  89. 6/6 doc/git-commit: add documentation for fixup=[amend|reword] optionsCharvi Mendiratta, Mar 10, 2021
  90. Junio C HamanoMar 11, 2021
  91. Charvi MendirattaMar 11, 2021
  92. Eric SunshineMar 11, 2021
  93. Charvi MendirattaMar 11, 2021
  94. 5/6 t3437: use --fixup with options to create amend! commitCharvi Mendiratta, Mar 10, 2021
  95. 4/6 t7500: add tests for --fixup=[amend|reword] optionsCharvi Mendiratta, Mar 10, 2021

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.