Documentation: Remove bogus claim about del_timer_sync()
authorThomas Gleixner <tglx@linutronix.de>
Wed, 23 Nov 2022 20:18:31 +0000 (21:18 +0100)
committerThomas Gleixner <tglx@linutronix.de>
Thu, 24 Nov 2022 14:09:10 +0000 (15:09 +0100)
commitb0b0aa5d858d4d2fe39a5e4486e0550e858108f6
tree1bd29b6e97371d48f74417c60cbb21f3d2c82b36
parent2f117484329b233455ee278f2d9b0a4356835060
Documentation: Remove bogus claim about del_timer_sync()

del_timer_sync() does not return the number of times it tried to delete the
timer which rearms itself. It's clearly documented:

 The function returns whether it has deactivated a pending timer or not.

This part of the documentation is from 2003 where del_timer_sync() really
returned the number of deletion attempts for unknown reasons. The code
was rewritten in 2005, but the documentation was not updated.

Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
Reviewed-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Link: https://lore.kernel.org/r/20221123201624.452282769@linutronix.de
Documentation/kernel-hacking/locking.rst
Documentation/translations/it_IT/kernel-hacking/locking.rst