From: Junio C Hamano <gitster@pobox•com>
To: "Tony Tung via GitGitGadget" <gitgitgadget@gmail•com>
Cc: git@vger•kernel.org, Tony Tung <tonytung@merly•org>
Subject: Re: [PATCH] sequencer: remove use of comment character
Date: Mon, 30 Oct 2023 13:00:50 +0900 [thread overview]
Message-ID: <xmqq7cn4g3nx.fsf@gitster.g> (raw)
In-Reply-To: <pull.1603.git.1698635292629.gitgitgadget@gmail.com> (Tony Tung via GitGitGadget's message of "Mon, 30 Oct 2023 03:08:12 +0000")
"Tony Tung via GitGitGadget" <gitgitgadget@gmail•com> writes:
> From: Tony Tung <tonytung@merly•org>
>
> Instead of using the hardcoded `# `, use the
> user-defined comment_line_char. Adds a test
> to prevent regressions.
Good spotting.
Two observations.
(1) There are a few more places that need similar treatment in the
same file; you may want to fix them all while at it.
(2) The second argument to strbuf_commented_addf() is always the
comment_line_char global variable, not just inside this file
but all callers across the codebase. We probably should drop
it and have the strbuf_commented_addf() helper itself refer to
the global. That way, if we ever want to change the global
variable reference to something else (e.g. function call), we
only have to touch a single place.
The latter is meant as #leftoverbits and will be a lot wider
clean-up that we may want to do long after this patch hits out
codebase. The "other places" I spotted for the former are the
following, but needs to be taken with a huge grain of salt, as it
has not even been compile tested.
Thanks.
sequencer.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git c/sequencer.c w/sequencer.c
index d584cac8ed..33208b1660 100644
--- c/sequencer.c
+++ w/sequencer.c
@@ -1893,8 +1893,8 @@ static void update_squash_message_for_fixup(struct strbuf *msg)
size_t orig_msg_len;
int i = 1;
- strbuf_addf(&buf1, "# %s\n", _(first_commit_msg_str));
- strbuf_addf(&buf2, "# %s\n", _(skip_first_commit_msg_str));
+ strbuf_addf(&buf1, comment_line_char, "%s\n", _(first_commit_msg_str));
+ strbuf_addf(&buf2, comment_line_char, "%s\n", _(skip_first_commit_msg_str));
s = start = orig_msg = strbuf_detach(msg, &orig_msg_len);
while (s) {
const char *next;
@@ -2269,8 +2269,8 @@ static int do_pick_commit(struct repository *r,
next = parent;
next_label = msg.parent_label;
if (opts->commit_use_reference) {
- strbuf_addstr(&msgbuf,
- "# *** SAY WHY WE ARE REVERTING ON THE TITLE LINE ***");
+ strbuf_commented_addf(&msgbuf, comment_line_char, "%s",
+ "*** SAY WHY WE ARE REVERTING ON THE TITLE LINE ***");
} else if (skip_prefix(msg.subject, "Revert \"", &orig_subject) &&
/*
* We don't touch pre-existing repeated reverts, because
next prev parent reply other threads:[~2023-10-30 4:00 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-30 3:08 [PATCH] sequencer: remove use of comment character Tony Tung via GitGitGadget
2023-10-30 4:00 ` Junio C Hamano [this message]
2023-10-30 17:26 ` Elijah Newren
2023-10-30 23:35 ` Junio C Hamano
2023-10-31 4:42 ` Tony Tung
2023-10-31 4:50 ` Tony Tung
2023-10-31 5:33 ` Junio C Hamano
2023-10-31 6:20 ` Elijah Newren
2023-10-31 5:09 ` [PATCH v2 0/2] sequencer: remove use of hardcoded comment char Tony Tung via GitGitGadget
2023-10-31 5:09 ` [PATCH v2 1/2] sequencer: remove use of comment character Tony Tung via GitGitGadget
2023-10-31 11:43 ` Phillip Wood
2023-11-01 4:59 ` Junio C Hamano
2023-10-31 5:09 ` [PATCH v2 2/2] sequencer: fix remaining hardcoded comment char Tony Tung via GitGitGadget
2023-10-31 11:27 ` Phillip Wood
2023-10-31 6:55 ` [PATCH v2 0/2] sequencer: remove use of " Elijah Newren
2023-10-31 11:18 ` Phillip Wood
2023-11-01 0:16 ` Junio C Hamano
2023-11-01 0:21 ` Elijah Newren
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq7cn4g3nx.fsf@gitster.g \
--to=gitster@pobox$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitgitgadget@gmail$(echo .)com \
--cc=tonytung@merly$(echo .)org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox