Re: [PATCH] time/timekeeping: Fix syntax errors in comments

From: Thomas Gleixner
Date: Fri Dec 17 2021 - 17:26:56 EST


On Sun, Dec 12 2021 at 22:32, Xiang wangx wrote:
> Delete the redundant word 'time'.
>
> Signed-off-by: Xiang wangx <wangxiang@xxxxxxxxxx>
> ---
> kernel/time/timekeeping.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/kernel/time/timekeeping.c b/kernel/time/timekeeping.c
> index b348749a9fc6..b1fbedd35300 100644
> --- a/kernel/time/timekeeping.c
> +++ b/kernel/time/timekeeping.c
> @@ -1148,7 +1148,7 @@ static int adjust_historical_crosststamp(struct system_time_snapshot *history,
> return ret;
> }
>
> - /* Fixup monotonic raw and real time time values */
> + /* Fixup monotonic raw and real time values */

It's not redundant because it talks about 'time values'. The 'time
values' which are fixed up are 'monotonic raw' and 'real time'.

So yes, the comment _is_ awkward and hard to read, but removing time
does not make it any better. Something like this;

/* Fixup the MONOTONIC_RAW and REAL_TIME time values */

Hmm?

Thanks,

tglx