]> www.infradead.org Git - users/jedix/linux-maple.git/commit
iopoll/regmap/phy/snd: Fix comment referencing outdated timer documentation
authorAnna-Maria Behnsen <anna-maria@linutronix.de>
Mon, 14 Oct 2024 08:22:29 +0000 (10:22 +0200)
committerThomas Gleixner <tglx@linutronix.de>
Tue, 15 Oct 2024 22:36:47 +0000 (00:36 +0200)
commit89124747f096fc0fe44be0162c7b4fb3271739e8
tree3104cc77b9d13bdf79d7e9a6438eed17934482f0
parent6534086aa684248f779944a2ac9253d6d637eec6
iopoll/regmap/phy/snd: Fix comment referencing outdated timer documentation

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.

Signed-off-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Andrew Lunn <andrew@lunn.ch> # for phy.h
Reviewed-by: Frederic Weisbecker <frederic@kernel.org>
Link: https://lore.kernel.org/all/20241014-devel-anna-maria-b4-timers-flseep-v3-12-dc8b907cb62f@linutronix.de
include/linux/iopoll.h
include/linux/phy.h
include/linux/regmap.h
sound/soc/sof/ops.h