Re: [PATCH] sequencer: comment checked-out branch properly

From: Phillip Wood <phillip.wood123@gmail.com>
Date: Oct 31, 2024, 09:58 UTC
Message-ID: <c05e603f-1fd4-4ad2-ba03-21269f464ed2@gmail.com>
In-Reply-To: <ZxlEJ+44M8z03VOj@nand.local>

On 23/10/2024 19:44, Taylor Blau wrote:

Show 18 quoted lines

> On Wed, Oct 23, 2024 at 07:27:58PM +0200, kristofferhaugsbakk@fastmail.com wrote:
>> @@ -6382,8 +6382,9 @@ static int add_decorations_to_list(const struct commit *commit,
>>   		/* If the branch is checked out, then leave a comment instead. */
>>   		if ((path = branch_checked_out(decoration->name))) {
>>   			item->command = TODO_COMMENT;
>> -			strbuf_addf(ctx->buf, "# Ref %s checked out at '%s'\n",
>> -				    decoration->name, path);
>> +			strbuf_commented_addf(ctx->buf, comment_line_str,
>> +					      "Ref %s checked out at '%s'\n",
>> +					      decoration->name, path);
> 
> Makes sense, but the following command turns up a couple more results
> even after applying:
> 
>      $ git grep -p 'strbuf_addf([^,]*, "#'
>      sequencer.c=static void update_squash_message_for_fixup(struct strbuf *msg)
>      sequencer.c:    strbuf_addf(&buf1, "# %s\n", _(first_commit_msg_str));
>      sequencer.c:    strbuf_addf(&buf2, "# %s\n", _(skip_first_commit_msg_str));

Good find - it's surprising that those have survived so long without anyone complaining. There is also

	"# *** SAY WHY WE ARE REVERTING ON THE TITLE LINE ***",

in do_pick_commit()

Best Wishes

Phillip

Show 30 quoted lines

>> diff --git a/t/t3400-rebase.sh b/t/t3400-rebase.sh
>> index 09f230eefb2..f61a717b190 100755
>> --- a/t/t3400-rebase.sh
>> +++ b/t/t3400-rebase.sh
>> @@ -456,4 +456,20 @@ test_expect_success 'rebase when inside worktree subdirectory' '
>>   	)
>>   '
>>
>> +test_expect_success 'git rebase --update-ref with core.commentChar and branch on worktree' '
>> +	test_when_finished git branch -D base topic2 &&
>> +	test_when_finished git checkout main &&
>> +	test_when_finished git branch -D wt-topic &&
>> +	test_when_finished git worktree remove wt-topic &&
>> +	git checkout main &&
>> +	git checkout -b base &&
>> +	git checkout -b topic2 &&
>> +	test_commit msg2 &&
>> +	git worktree add wt-topic &&
>> +	git checkout base &&
>> +	test_commit msg3 &&
>> +	git checkout topic2 &&
>> +	git -c core.commentChar=% rebase --update-refs base
>> +'
>> +
> 
> Seems quite reasonable.
> 
> Thanks,
> Taylor
>