All of lore.kernel.org
 help / color / mirror / Atom feed
From: Thomas Gleixner <tglx@linutronix.de>
To: LKML <linux-kernel@vger.kernel.org>
Cc: Linus Torvalds <torvalds@linuxfoundation.org>,
	Steven Rostedt <rostedt@goodmis.org>,
	Anna-Maria Behnsen <anna-maria@linutronix.de>,
	Peter Zijlstra <peterz@infradead.org>,
	Stephen Boyd <sboyd@kernel.org>,
	Guenter Roeck <linux@roeck-us.net>,
	Andrew Morton <akpm@linux-foundation.org>,
	Julia Lawall <Julia.Lawall@inria.fr>,
	Arnd Bergmann <arnd@arndb.de>,
	Viresh Kumar <viresh.kumar@linaro.org>,
	Marc Zyngier <maz@kernel.org>,
	Marcel Holtmann <marcel@holtmann.org>,
	Johan Hedberg <johan.hedberg@gmail.com>,
	Luiz Augusto von Dentz <luiz.dentz@gmail.com>,
	linux-bluetooth@vger.kernel.org,
	"David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
	netdev@vger.kernel.org
Subject: [patch V2 01/17] Documentation: Remove bogus claim about del_timer_sync()
Date: Tue, 22 Nov 2022 18:44:45 +0100 (CET)	[thread overview]
Message-ID: <20221122173648.153480304@linutronix.de> (raw)
In-Reply-To: 20221122171312.191765396@linutronix.de

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. This code
was rewritten in 2005, but the documentation was not updated.

Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
---
 Documentation/kernel-hacking/locking.rst                    |    3 +--
 Documentation/translations/it_IT/kernel-hacking/locking.rst |    4 +---
 2 files changed, 2 insertions(+), 5 deletions(-)

--- a/Documentation/kernel-hacking/locking.rst
+++ b/Documentation/kernel-hacking/locking.rst
@@ -1006,8 +1006,7 @@ Another common problem is deleting timer
 calling add_timer() at the end of their timer function).
 Because this is a fairly common case which is prone to races, you should
 use del_timer_sync() (``include/linux/timer.h``) to
-handle this case. It returns the number of times the timer had to be
-deleted before we finally stopped it from adding itself back in.
+handle this case.
 
 Locking Speed
 =============
--- a/Documentation/translations/it_IT/kernel-hacking/locking.rst
+++ b/Documentation/translations/it_IT/kernel-hacking/locking.rst
@@ -1027,9 +1027,7 @@ Un altro problema è l'eliminazione dei
 da soli (chiamando add_timer() alla fine della loro esecuzione).
 Dato che questo è un problema abbastanza comune con una propensione
 alle corse critiche, dovreste usare del_timer_sync()
-(``include/linux/timer.h``) per gestire questo caso. Questa ritorna il
-numero di volte che il temporizzatore è stato interrotto prima che
-fosse in grado di fermarlo senza che si riavviasse.
+(``include/linux/timer.h``) per gestire questo caso.
 
 Velocità della sincronizzazione
 ===============================


  reply	other threads:[~2022-11-22 17:45 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-22 17:44 [patch V2 00/17] timers: Provide timer_shutdown[_sync]() Thomas Gleixner
2022-11-22 17:44 ` Thomas Gleixner [this message]
2022-11-22 18:37   ` bluez.test.bot
2022-11-22 17:44 ` [patch V2 02/17] ARM: spear: Do not use timer namespace for timer_shutdown() function Thomas Gleixner
2022-11-22 17:44 ` [patch V2 03/17] clocksource/drivers/arm_arch_timer: " Thomas Gleixner
2022-11-22 17:44 ` [patch V2 04/17] clocksource/drivers/sp804: " Thomas Gleixner
2022-11-22 17:44 ` [patch V2 05/17] timers: Get rid of del_singleshot_timer_sync() Thomas Gleixner
2022-11-22 17:44 ` [patch V2 06/17] timers: Replace BUG_ON()s Thomas Gleixner
2022-11-22 17:44 ` [patch V2 07/17] timers: Update kernel-doc for various functions Thomas Gleixner
2022-11-23 10:23   ` Anna-Maria Behnsen
2022-11-23 17:09     ` Thomas Gleixner
2022-11-22 17:44 ` [patch V2 08/17] timers: Use del_timer_sync() even on UP Thomas Gleixner
2022-11-22 17:44 ` [patch V2 09/17] timers: Rename del_timer_sync() to timer_delete_sync() Thomas Gleixner
2022-11-22 22:23   ` David Laight
2022-11-22 22:45     ` Steven Rostedt
2022-11-23  0:08       ` Thomas Gleixner
2022-11-23  0:28         ` Steven Rostedt
2022-11-22 17:45 ` [patch V2 10/17] timers: Rename del_timer() to timer_delete() Thomas Gleixner
2022-11-22 17:45 ` [patch V2 11/17] Documentation: Replace del_timer/del_timer_sync() Thomas Gleixner
2022-11-22 17:45 ` [patch V2 12/17] timers: Silently ignore timers with a NULL function Thomas Gleixner
2022-11-23  9:22   ` Anna-Maria Behnsen
2022-11-23 10:39   ` Anna-Maria Behnsen
2022-11-23 11:06   ` Anna-Maria Behnsen
2022-11-23 17:08     ` Thomas Gleixner
2022-11-22 17:45 ` [patch V2 13/17] timers: Split [try_to_]del_timer[_sync]() to prepare for shutdown mode Thomas Gleixner
2022-11-22 23:04   ` Jacob Keller
2022-11-23 17:05     ` Thomas Gleixner
2022-11-23 18:45       ` Jacob Keller
2022-11-23 11:23   ` Anna-Maria Behnsen
2022-11-23 11:24     ` Anna-Maria Behnsen
2022-11-22 17:45 ` [patch V2 14/17] timers: Add shutdown mechanism to the internal functions Thomas Gleixner
2022-11-22 17:45 ` [patch V2 15/17] timers: Provide timer_shutdown[_sync]() Thomas Gleixner
2022-11-23 12:02   ` Anna-Maria Behnsen
2022-11-23 17:06     ` Thomas Gleixner
2022-11-22 17:45 ` [patch V2 16/17] timers: Update the documentation to reflect on the new timer_shutdown() API Thomas Gleixner
2022-11-22 17:45 ` [patch V2 17/17] Bluetooth: hci_qca: Fix the teardown problem for real Thomas Gleixner
2022-11-22 23:09 ` [patch V2 00/17] timers: Provide timer_shutdown[_sync]() Jacob Keller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221122173648.153480304@linutronix.de \
    --to=tglx@linutronix.de \
    --cc=Julia.Lawall@inria.fr \
    --cc=akpm@linux-foundation.org \
    --cc=anna-maria@linutronix.de \
    --cc=arnd@arndb.de \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=johan.hedberg@gmail.com \
    --cc=kuba@kernel.org \
    --cc=linux-bluetooth@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=luiz.dentz@gmail.com \
    --cc=marcel@holtmann.org \
    --cc=maz@kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=peterz@infradead.org \
    --cc=rostedt@goodmis.org \
    --cc=sboyd@kernel.org \
    --cc=torvalds@linuxfoundation.org \
    --cc=viresh.kumar@linaro.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.