system/linux
system/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux synced 2024-10-15 15:59:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Remove bogus claim about del_timer_sync()

Browse source 
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
This commit is contained in:
Thomas Gleixner 2022-11-23 21:18:31 +01:00
parent 2f11748432
commit b0b0aa5d85
2 changed files with 2 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Documentation/kernel-hacking/locking.rst
View file

@ -1006,8 +1006,7 @@ Another common problem is deleting timers which restart themselves (by
calling add_timer() at the end of their timer function). calling add_timer() at the end of their timer function).
Because this is a fairly common case which is prone to races, you should Because this is a fairly common case which is prone to races, you should
use del_timer_sync() (``include/linux/timer.h``) to use del_timer_sync() (``include/linux/timer.h``) to
handle this case. It returns the number of times the timer had to be handle this case.
deleted before we finally stopped it from adding itself back in.
Locking Speed Locking Speed
============= =============

4
Documentation/translations/it_IT/kernel-hacking/locking.rst
View file

@ -1027,9 +1027,7 @@ Un altro problema è l'eliminazione dei temporizzatori che si riavviano
da soli (chiamando add_timer() alla fine della loro esecuzione). da soli (chiamando add_timer() alla fine della loro esecuzione).
Dato che questo è un problema abbastanza comune con una propensione Dato che questo è un problema abbastanza comune con una propensione
alle corse critiche, dovreste usare del_timer_sync() alle corse critiche, dovreste usare del_timer_sync()
(``include/linux/timer.h``) per gestire questo caso. Questa ritorna il (``include/linux/timer.h``) per gestire questo caso.
numero di volte che il temporizzatore è stato interrotto prima che
fosse in grado di fermarlo senza che si riavviasse.
Velocità della sincronizzazione Velocità della sincronizzazione
=============================== ===============================