Re: [PATCH v2 12/15] iopoll/regmap/phy/snd: Fix comment referencing outdated timer documentation
From: Andrew Lunn
Date: Wed Sep 11 2024 - 08:08:47 EST
On Wed, Sep 11, 2024 at 07:13:38AM +0200, Anna-Maria Behnsen wrote:
> Function descriptions in iopoll.h, regmap.h, phy.h and sound/soc/sof/ops.h
> copied all the same outdated documentation about sleep/delay function
> limitations. In those comments, the generic (and still outdated) timer
> documentation file is referenced.
>
> As proper function descriptions for used delay and sleep functions are in
> place, simply update the descriptions to reference to them. While at it fix
> missing colon after "Returns" in function description and move return value
> description to the end of the function description.
>
> Cc: Andrew Lunn <andrew@xxxxxxx>
> Cc: Heiner Kallweit <hkallweit1@xxxxxxxxx>
> Cc: Jaroslav Kysela <perex@xxxxxxxx>
> Cc: Takashi Iwai <tiwai@xxxxxxxx>
> Cc: netdev@xxxxxxxxxxxxxxx
> Cc: linux-sound@xxxxxxxxxxxxxxx
> Signed-off-by: Anna-Maria Behnsen <anna-maria@xxxxxxxxxxxxx>
> ---
> v2: Add cleanup of usage of 'Returns' in function description
> ---
> include/linux/iopoll.h | 52 +++++++++++++++++++++++++-------------------------
> include/linux/phy.h | 9 +++++----
For the phy.h parts:
Reviewed-by: Andrew Lunn <andrew@xxxxxxx>
Andrew