Re: [PATCH 12/15] iopoll/regmap/phy/snd: Fix comment referencing outdated timer documentation

Anna-Maria Behnsen
2024-09-05T08:15:44Z

Andrew Lunn <andrew@lunn.ch> writes:

>> diff --git a/include/linux/phy.h b/include/linux/phy.h
>> index 6b7d40d49129..b09490e08365 100644
>> --- a/include/linux/phy.h
>> +++ b/include/linux/phy.h
>> @@ -1374,11 +1374,12 @@ int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
>> * @regnum: The register on the MMD to read
>> * @val: Variable to read the register into
>> * @cond: Break condition (usually involving @val)
>> - * @sleep_us: Maximum time to sleep between reads in us (0
>> - * tight-loops). Should be less than ~20ms since usleep_range
>> - * is used (see Documentation/timers/timers-howto.rst).
>> + * @sleep_us: Maximum time to sleep between reads in us (0 tight-loops). Please
>> + * read usleep_range() function description for details and
>> + * limitations.
>> * @timeout_us: Timeout in us, 0 means never timeout
>> * @sleep_before_read: if it is true, sleep @sleep_us before read.
>> + *
>> * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
>
> I know it is not in scope for what you are trying to fix, but there
> should be a : after Returns
>
> * Returns: 0 on success and -ETIMEDOUT upon a timeout. In either

I have to do a v2 of the series anyway. So if it helps, I can add the
missing colon after "Returns" in all those function descriptions I touch
and expand the commit message by:

While at it fix missing colon after "Returns" in function description
as well.

> Reviewed-by: Andrew Lunn <andrew@lunn.ch>
>
> Andrew

Thanks,

Anna-Maria