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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <0a7f2282-cbd0-4f27-bfe4-30b0c1a4705b@lunn.ch>
Date: Wed, 11 Sep 2024 14:08:19 +0200
From: Andrew Lunn <andrew@...n.ch>
To: Anna-Maria Behnsen <anna-maria@...utronix.de>
Cc: Frederic Weisbecker <frederic@...nel.org>,
	Thomas Gleixner <tglx@...utronix.de>,
	Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
	Len Brown <len.brown@...el.com>,
	"Rafael J. Wysocki" <rafael@...nel.org>,
	Heiner Kallweit <hkallweit1@...il.com>,
	Jaroslav Kysela <perex@...ex.cz>, Takashi Iwai <tiwai@...e.com>,
	netdev@...r.kernel.org, linux-sound@...r.kernel.org
Subject: Re: [PATCH v2 12/15] iopoll/regmap/phy/snd: Fix comment referencing
 outdated timer documentation

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@...n.ch>
> Cc: Heiner Kallweit <hkallweit1@...il.com>
> Cc: Jaroslav Kysela <perex@...ex.cz>
> Cc: Takashi Iwai <tiwai@...e.com>
> Cc: netdev@...r.kernel.org
> Cc: linux-sound@...r.kernel.org
> Signed-off-by: Anna-Maria Behnsen <anna-maria@...utronix.de>
> ---
> 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@...n.ch>

    Andrew