From: Junio C Hamano <gitster@pobox.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: Charvi Mendiratta <charvi077@gmail.com>,
Git List <git@vger.kernel.org>,
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: Sat, 13 Mar 2021 18:25:10 -0800 [thread overview]
Message-ID: <xmqqft0y4gl5.fsf@gitster.g> (raw)
In-Reply-To: <CAPig+cTBXBjZkJoGFYpzWBnEOmV52dnoBHxceuoe3pu3F0BnYw@mail.gmail.com> (Eric Sunshine's message of "Thu, 11 Mar 2021 12:07:53 -0500")
Eric Sunshine <sunshine@sunshineco.com> writes:
> 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).
I actually think the helper function that is used as a building
block the "subcommand parser" uses should be named more directly
to represent what it does (i.e. look for a run of alphas) than
what it means (i.e. look for a run of letters allowed in a
subcommand name). IOW
char *end = skip_alphas(ptr);
if (*end == ':' && ptr != end) {
/*
* ptr..end could be a subcommand in
* "--fixup=<subcommand>:"; see if it is a known one
*/
*end = '\0';
if (!strcmp(ptr, "amend"))
... do the amend thing ...
else if (!strcmp(ptr, "reword"))
... do the reword thing ...
else
... we do not know such a subcommand yet ...
} else {
/* assume it is --fixup=<command> form */
...
}
conveys more information to readers than a variant where you replace
"skip_alphas" with "skip_subcommand_chars" without losing any
information.
Yes, in different contexts, where a helpers are designed to be used
by multiple callers that may not even be aware of each other, we do
encourage naming them after what they do _means_. But in this
codepath, I do not think it applies.
Thanks.
next prev parent reply other threads:[~2021-03-14 2:26 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
2021-03-14 2:25 ` Junio C Hamano [this message]
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=xmqqft0y4gl5.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=charvi077@gmail.com \
--cc=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--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).