From: Charvi Mendiratta <charvi077@gmail.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: Git List <git@vger.kernel.org>,
Junio C Hamano <gitster@pobox.com>,
Christian Couder <chriscool@tuxfamily.org>,
Phillip Wood <phillip.wood@dunelm.org.uk>
Subject: Re: [PATCH v4 2/6] commit: add amend suboption to --fixup to create amend! commit
Date: Thu, 11 Mar 2021 23:21:01 +0530 [thread overview]
Message-ID: <CAPSFM5fc_TtSxFkLvMSN3sX18TLq9ijUQ0Aw8z0P+OG=BMGwqQ@mail.gmail.com> (raw)
In-Reply-To: <CAPig+cTBXBjZkJoGFYpzWBnEOmV52dnoBHxceuoe3pu3F0BnYw@mail.gmail.com>
On Thu, 11 Mar 2021 at 22:38, Eric Sunshine <sunshine@sunshineco.com> wrote:
>
> 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
next prev parent reply other threads:[~2021-03-11 17:52 UTC|newest]
Thread overview: 95+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-01 8:45 [PATCH v3 0/6][Outreachy] commit: Implementation of "amend!" commit Charvi Mendiratta
2021-03-01 8:45 ` [PATCH v3 1/6] sequencer: export subject_length() Charvi Mendiratta
2021-03-01 20:25 ` Eric Sunshine
2021-03-03 6:26 ` Junio C Hamano
2021-03-03 7:35 ` Charvi Mendiratta
2021-03-01 8:45 ` [PATCH v3 2/6] commit: add amend suboption to --fixup to create amend! commit Charvi Mendiratta
2021-03-01 18:34 ` Junio C Hamano
2021-03-03 7:32 ` Charvi Mendiratta
2021-03-01 22:15 ` Eric Sunshine
2021-03-01 22:32 ` Junio C Hamano
2021-03-01 22:47 ` Eric Sunshine
2021-03-03 7:42 ` Charvi Mendiratta
2021-03-03 7:41 ` Charvi Mendiratta
2021-03-03 7:57 ` Eric Sunshine
2021-03-03 19:21 ` Charvi Mendiratta
2021-03-04 0:58 ` Junio C Hamano
2021-03-04 9:01 ` Charvi Mendiratta
2021-03-03 7:37 ` Charvi Mendiratta
2021-03-03 7:46 ` Eric Sunshine
2021-03-03 19:21 ` Charvi Mendiratta
2021-03-01 8:45 ` [PATCH v3 3/6] commit: add a reword suboption to --fixup Charvi Mendiratta
2021-03-01 18:41 ` Junio C Hamano
2021-03-03 7:33 ` Charvi Mendiratta
2021-03-01 22:36 ` Eric Sunshine
2021-03-03 7:41 ` Charvi Mendiratta
2021-03-01 8:45 ` [PATCH v3 4/6] t7500: add tests for --fixup=[amend|reword] options Charvi Mendiratta
2021-03-02 5:43 ` Eric Sunshine
2021-03-03 6:28 ` Junio C Hamano
2021-03-03 7:43 ` Charvi Mendiratta
2021-03-01 8:45 ` [PATCH v3 5/6] t3437: use --fixup with options to create amend! commit Charvi Mendiratta
2021-03-01 8:45 ` [PATCH v3 6/6] doc/git-commit: add documentation for fixup=[amend|reword] options Charvi Mendiratta
2021-03-01 18:44 ` Junio C Hamano
2021-03-03 7:33 ` Charvi Mendiratta
2021-03-02 6:39 ` Eric Sunshine
2021-03-03 7:43 ` Charvi Mendiratta
2021-03-03 8:18 ` Eric Sunshine
2021-03-03 19:22 ` Charvi Mendiratta
2021-03-04 1:05 ` Junio C Hamano
2021-03-04 9:00 ` Charvi Mendiratta
2021-03-04 22:18 ` Junio C Hamano
2021-03-05 6:14 ` Charvi Mendiratta
2021-03-05 18:25 ` Junio C Hamano
2021-03-06 4:13 ` Charvi Mendiratta
2021-03-06 6:11 ` Eric Sunshine
2021-03-01 18:45 ` [PATCH v3 0/6][Outreachy] commit: Implementation of "amend!" commit Junio C Hamano
2021-03-03 7:33 ` Charvi Mendiratta
2021-03-10 19:43 ` [PATCH v4 " Charvi Mendiratta
2021-03-11 8:06 ` Eric Sunshine
2021-03-11 15:24 ` Charvi Mendiratta
2021-03-13 13:40 ` [PATCH v5 " Charvi Mendiratta
2021-03-13 13:40 ` [PATCH v5 1/6] sequencer: export and rename subject_length() Charvi Mendiratta
2021-03-13 13:40 ` [PATCH v5 2/6] commit: add amend suboption to --fixup to create amend! commit Charvi Mendiratta
2021-03-14 1:32 ` Eric Sunshine
2021-03-13 13:40 ` [PATCH v5 3/6] commit: add a reword suboption to --fixup Charvi Mendiratta
2021-03-13 13:40 ` [PATCH v5 4/6] t7500: add tests for --fixup=[amend|reword] options Charvi Mendiratta
2021-03-13 13:40 ` [PATCH v5 5/6] t3437: use --fixup with options to create amend! commit Charvi Mendiratta
2021-03-13 13:40 ` [PATCH v5 6/6] doc/git-commit: add documentation for fixup=[amend|reword] options Charvi Mendiratta
2021-03-14 1:10 ` Eric Sunshine
2021-03-14 13:57 ` Charvi Mendiratta
2021-03-15 7:54 ` [PATCH v6 0/6][Outreachy] commit: Implementation of "amend!" commit Charvi Mendiratta
2021-03-19 0:52 ` Junio C Hamano
2021-03-19 3:16 ` Eric Sunshine
2021-03-19 14:10 ` Charvi Mendiratta
2021-03-15 7:54 ` [PATCH v6 1/6] sequencer: export and rename subject_length() Charvi Mendiratta
2021-03-15 7:54 ` [PATCH v6 2/6] commit: add amend suboption to --fixup to create amend! commit Charvi Mendiratta
2021-03-15 7:54 ` [PATCH v6 3/6] commit: add a reword suboption to --fixup Charvi Mendiratta
2021-03-15 7:54 ` [PATCH v6 4/6] t7500: add tests for --fixup=[amend|reword] options Charvi Mendiratta
2021-03-15 7:54 ` [PATCH v6 5/6] t3437: use --fixup with options to create amend! commit Charvi Mendiratta
2021-03-15 7:54 ` [PATCH v6 6/6] doc/git-commit: add documentation for fixup=[amend|reword] options Charvi Mendiratta
2021-03-10 19:43 ` [PATCH v4 1/6] sequencer: export and rename subject_length() Charvi Mendiratta
2021-03-10 19:43 ` [PATCH v4 2/6] commit: add amend suboption to --fixup to create amend! commit Charvi Mendiratta
2021-03-11 6:25 ` Eric Sunshine
2021-03-11 15:24 ` Charvi Mendiratta
2021-03-11 17:07 ` Eric Sunshine
2021-03-11 17:51 ` Charvi Mendiratta [this message]
2021-03-14 2:25 ` Junio C Hamano
2021-03-14 13:58 ` Charvi Mendiratta
2021-03-14 22:43 ` Junio C Hamano
2021-03-14 23:07 ` Eric Sunshine
2021-03-15 7:59 ` Charvi Mendiratta
2021-03-15 8:16 ` Eric Sunshine
2021-03-15 9:35 ` Charvi Mendiratta
2021-03-10 19:43 ` [PATCH v4 3/6] commit: add a reword suboption to --fixup Charvi Mendiratta
2021-03-11 0:31 ` Junio C Hamano
2021-03-11 4:01 ` Charvi Mendiratta
2021-03-11 5:37 ` Junio C Hamano
2021-03-11 6:37 ` Eric Sunshine
2021-03-11 15:23 ` Charvi Mendiratta
2021-03-10 19:43 ` [PATCH v4 4/6] t7500: add tests for --fixup=[amend|reword] options Charvi Mendiratta
2021-03-10 19:43 ` [PATCH v4 5/6] t3437: use --fixup with options to create amend! commit Charvi Mendiratta
2021-03-10 19:43 ` [PATCH v4 6/6] doc/git-commit: add documentation for fixup=[amend|reword] options Charvi Mendiratta
2021-03-11 0:30 ` Junio C Hamano
2021-03-11 4:02 ` Charvi Mendiratta
2021-03-11 7:48 ` Eric Sunshine
2021-03-11 15:24 ` Charvi Mendiratta
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAPSFM5fc_TtSxFkLvMSN3sX18TLq9ijUQ0Aw8z0P+OG=BMGwqQ@mail.gmail.com' \
--to=charvi077@gmail.com \
--cc=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=phillip.wood@dunelm.org.uk \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).