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

Andrew Lunn
2024-09-04T14:03:29Z

> 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

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

Andrew