]> git.ipfire.org Git - thirdparty/kernel/stable.git/commit
timers: Update the documentation to reflect on the new timer_shutdown() API
authorSteven Rostedt (Google) <rostedt@goodmis.org>
Fri, 10 Oct 2025 15:02:51 +0000 (00:02 +0900)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Wed, 29 Oct 2025 13:04:32 +0000 (14:04 +0100)
commite77cf6a1f64e3ce868bc6eb2ed2f9409e2f30540
tree1b0692936a83fa41530b177d9b09003e4fe646d2
parent59b82a2e0c16832b63678d4d966ef617a68a9e8f
timers: Update the documentation to reflect on the new timer_shutdown() API

[ Upstream commit a31323bef2b66455920d054b160c17d4240f8fd4 ]

In order to make sure that a timer is not re-armed after it is stopped
before freeing, a new shutdown state is added to the timer code. The API
timer_shutdown_sync() and timer_shutdown() must be called before the
object that holds the timer can be freed.

Update the documentation to reflect this new workflow.

[ tglx: Updated to the new semantics and updated the zh_CN version ]

Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Tested-by: Guenter Roeck <linux@roeck-us.net>
Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
Reviewed-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Link: https://lore.kernel.org/r/20221110064147.712934793@goodmis.org
Link: https://lore.kernel.org/r/20221123201625.375284489@linutronix.de
Signed-off-by: Jeongjun Park <aha310510@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/RCU/Design/Requirements/Requirements.rst
Documentation/core-api/local_ops.rst
Documentation/kernel-hacking/locking.rst
Documentation/translations/zh_CN/core-api/local_ops.rst