OSDN Git Service

timers: Update the documentation to reflect on the new timer_shutdown() API
authorSteven Rostedt (Google) <rostedt@goodmis.org>
Wed, 23 Nov 2022 20:18:55 +0000 (21:18 +0100)
committerThomas Gleixner <tglx@linutronix.de>
Thu, 24 Nov 2022 14:09:12 +0000 (15:09 +0100)
commita31323bef2b66455920d054b160c17d4240f8fd4
treeb7c9ba77bc3b47b7333e2024a3668bcd30c763e9
parentf571faf6e443b6011ccb585d57866177af1f643c
timers: Update the documentation to reflect on the new timer_shutdown() API

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
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