Re: [Outreachy][PATCH] branch.c: adjust error messages to coding guidelines

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 18, 2023, 18:44 UTC
Message-ID: <xmqqv8b3srbu.fsf@gitster.g>
In-Reply-To: <e08b2ec4-786a-4c18-b7af-0a6a250ae0f0@gmail.com>

Rubén Justo <rjusto@gmail.com> writes:

Show 11 quoted lines

> On 18-oct-2023 06:12:22, Isoken June Ibizugbe wrote:
>
>> Signed-off-by: Isoken June Ibizugbe <isokenjune@gmail.com>
>> ---
>>  builtin/branch.c | 66 ++++++++++++++++++++++++------------------------
>>  1 file changed, 33 insertions(+), 33 deletions(-)
>
> Only builtin/branch.c is touched.
>
> The changes in this patch break some tests, therefore this patch must
> also include the fixes for those tests.

Good point. I also notice the lack of body in the proposed commit message. It should say which part(s) of "coding guidelines" this change wants to make the code adhere to (maybe later we might change the guideline, and those who find this commit via "git blame" needs to understand what exact rule this change was aiming to follow, before they are confident that the change they plan to make is good).

Show 10 quoted lines

>> @@ -965,11 +965,11 @@ int cmd_branch(int argc, const char **argv, const char *prefix)
>>  		const char *start_name = argc == 2 ? argv[1] : head;
>>  
>>  		if (filter.kind != FILTER_REFS_BRANCHES)
>> -			die(_("The -a, and -r, options to 'git branch' do not take a branch name.\n"
>> +			die(_("the -a, and -r, options to 'git branch' do not take a branch name\n"
>>  				  "Did you mean to use: -a|-r --list <pattern>?"));
>
> OK.  The initial 'T' is fixed, but as Junio explained [1], the full stop
> must stay.

Thanks for pointing out that it will help mentorship applicants to learn from reviews the other applicants are receiving, as they tend to make similar mistakes.

>
> Thanks.
>
>  [1] https://lore.kernel.org/git/xmqqttqxkmaq.fsf@gitster.g/