Re: [PATCH] [Outreachy] patch-ids: fix NEEDSWORK timezone parsing in fast-import.c

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 10, 2025, 15:45 UTC
Message-ID: <xmqq1pnabw1p.fsf@gitster.g>
In-Reply-To: <aOiZ_v3bO35oVWf-@pks.im>

Patrick Steinhardt <ps@pks.im> writes:

Show 44 quoted lines

> On Fri, Oct 10, 2025 at 12:49:57AM +0100, Okhuomon Ajayi wrote:
>> Signed-off-by: Okhuomon Ajayi <okhuomonajayi54@gmail.com>
>> ---
>
> For a change like this it is important to explain what the problem is,
> why it is a problem and how your change improves the code for the
> better. All of this needs to be patr of the commit message so that the
> reader can understand what you're actually doing.
>
> Also, if this fixes a real issue, is it possible to demonstrate the
> issue and the fix with a test?
>
>> diff --git a/builtin/fast-import.c b/builtin/fast-import.c
>> index 606c6aea82..695e1a0ae1 100644
>> --- a/builtin/fast-import.c
>> +++ b/builtin/fast-import.c
>> @@ -1959,14 +1959,15 @@ static int validate_raw_date(const char *src, struct strbuf *result, int strict)
>>  		return -1;
>>  
>>  	num = strtoul(src + 1, &endp, 10);
>> -	/*
>> -	 * NEEDSWORK: check for brokenness other than num > 1400, such as
>> -	 *            (num % 100) >= 60, or ((num % 100) % 15) != 0 ?
>> -	 */
>> -	if (errno || endp == src + 1 || *endp || /* did not parse */
>> -	    (strict && (1400 < num))             /* parsed a broken timezone */
>> -	   )
>> +	
>> +
>> +        unsigned int hours = num / 100;
>> +        unsigned int minutes = num % 100;
>> +
>> +	if (errno || endp == src + 1 || *endp || 
>> +	    (strict && (num > 1400 || minutes >=60 || minutes % 15 != 0))){
>>  		return -1;
>> +	}
>
> Despite the formatting issues I also think that this here is becoming
> hard to read. It may make sense to split this up into multiple
> conditions.
>
> Thanks!
>
> Patrick

Thanks for a good suggestion.

There is another thing we should be aware of about these NEEDSWORK comments. Often, the task a NEEDSWORK comment suggests includes and starts from assessing if the task indeed is worth doing. We should read a NEEDSWORK comment like above one as its author mumbling to themselves: this feels lacking, and we may want to do more here, like X and Y and Z. Maybe not.

Do we need to check even more precisely here? What's the point of doing so, and doing so here at this point in the control flow? Are there better approaches than incrementally adding more of similar kinds of checks?

Without being able to answer these questions oneself, one shouldn't be blindly following what a NEEDSWORK comment like this floats as "ideas to do more".

The current code may turn out to be good enough. Removing the NEEDSWORK comment with a solid answer to the question it poses in the proposed log message would be a commit worth making in such a case.

Thanks.