Commit 9e643ab5 authored by Randy Dunlap's avatar Randy Dunlap Committed by Ingo Molnar

timers: Fix text inconsistencies and spelling

Fix some text for consistency: s/lvl/level/ in a comment and use
correct/full function names in comments.

Correct spelling errors as reported by codespell.
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
Link: https://lore.kernel.org/r/20240331172652.14086-7-rdunlap@infradead.org
parent ba6ad57b
...@@ -64,15 +64,15 @@ EXPORT_SYMBOL(jiffies_64); ...@@ -64,15 +64,15 @@ EXPORT_SYMBOL(jiffies_64);
/* /*
* The timer wheel has LVL_DEPTH array levels. Each level provides an array of * The timer wheel has LVL_DEPTH array levels. Each level provides an array of
* LVL_SIZE buckets. Each level is driven by its own clock and therefor each * LVL_SIZE buckets. Each level is driven by its own clock and therefore each
* level has a different granularity. * level has a different granularity.
* *
* The level granularity is: LVL_CLK_DIV ^ lvl * The level granularity is: LVL_CLK_DIV ^ level
* The level clock frequency is: HZ / (LVL_CLK_DIV ^ level) * The level clock frequency is: HZ / (LVL_CLK_DIV ^ level)
* *
* The array level of a newly armed timer depends on the relative expiry * The array level of a newly armed timer depends on the relative expiry
* time. The farther the expiry time is away the higher the array level and * time. The farther the expiry time is away the higher the array level and
* therefor the granularity becomes. * therefore the granularity becomes.
* *
* Contrary to the original timer wheel implementation, which aims for 'exact' * Contrary to the original timer wheel implementation, which aims for 'exact'
* expiry of the timers, this implementation removes the need for recascading * expiry of the timers, this implementation removes the need for recascading
...@@ -207,7 +207,7 @@ EXPORT_SYMBOL(jiffies_64); ...@@ -207,7 +207,7 @@ EXPORT_SYMBOL(jiffies_64);
* struct timer_base - Per CPU timer base (number of base depends on config) * struct timer_base - Per CPU timer base (number of base depends on config)
* @lock: Lock protecting the timer_base * @lock: Lock protecting the timer_base
* @running_timer: When expiring timers, the lock is dropped. To make * @running_timer: When expiring timers, the lock is dropped. To make
* sure not to race agains deleting/modifying a * sure not to race against deleting/modifying a
* currently running timer, the pointer is set to the * currently running timer, the pointer is set to the
* timer, which expires at the moment. If no timer is * timer, which expires at the moment. If no timer is
* running, the pointer is NULL. * running, the pointer is NULL.
...@@ -737,7 +737,7 @@ static bool timer_is_static_object(void *addr) ...@@ -737,7 +737,7 @@ static bool timer_is_static_object(void *addr)
} }
/* /*
* fixup_init is called when: * timer_fixup_init is called when:
* - an active object is initialized * - an active object is initialized
*/ */
static bool timer_fixup_init(void *addr, enum debug_obj_state state) static bool timer_fixup_init(void *addr, enum debug_obj_state state)
...@@ -761,7 +761,7 @@ static void stub_timer(struct timer_list *unused) ...@@ -761,7 +761,7 @@ static void stub_timer(struct timer_list *unused)
} }
/* /*
* fixup_activate is called when: * timer_fixup_activate is called when:
* - an active object is activated * - an active object is activated
* - an unknown non-static object is activated * - an unknown non-static object is activated
*/ */
...@@ -783,7 +783,7 @@ static bool timer_fixup_activate(void *addr, enum debug_obj_state state) ...@@ -783,7 +783,7 @@ static bool timer_fixup_activate(void *addr, enum debug_obj_state state)
} }
/* /*
* fixup_free is called when: * timer_fixup_free is called when:
* - an active object is freed * - an active object is freed
*/ */
static bool timer_fixup_free(void *addr, enum debug_obj_state state) static bool timer_fixup_free(void *addr, enum debug_obj_state state)
...@@ -801,7 +801,7 @@ static bool timer_fixup_free(void *addr, enum debug_obj_state state) ...@@ -801,7 +801,7 @@ static bool timer_fixup_free(void *addr, enum debug_obj_state state)
} }
/* /*
* fixup_assert_init is called when: * timer_fixup_assert_init is called when:
* - an untracked/uninit-ed object is found * - an untracked/uninit-ed object is found
*/ */
static bool timer_fixup_assert_init(void *addr, enum debug_obj_state state) static bool timer_fixup_assert_init(void *addr, enum debug_obj_state state)
...@@ -914,7 +914,7 @@ static void do_init_timer(struct timer_list *timer, ...@@ -914,7 +914,7 @@ static void do_init_timer(struct timer_list *timer,
* @key: lockdep class key of the fake lock used for tracking timer * @key: lockdep class key of the fake lock used for tracking timer
* sync lock dependencies * sync lock dependencies
* *
* init_timer_key() must be done to a timer prior calling *any* of the * init_timer_key() must be done to a timer prior to calling *any* of the
* other timer functions. * other timer functions.
*/ */
void init_timer_key(struct timer_list *timer, void init_timer_key(struct timer_list *timer,
...@@ -1417,7 +1417,7 @@ static int __timer_delete(struct timer_list *timer, bool shutdown) ...@@ -1417,7 +1417,7 @@ static int __timer_delete(struct timer_list *timer, bool shutdown)
* If @shutdown is set then the lock has to be taken whether the * If @shutdown is set then the lock has to be taken whether the
* timer is pending or not to protect against a concurrent rearm * timer is pending or not to protect against a concurrent rearm
* which might hit between the lockless pending check and the lock * which might hit between the lockless pending check and the lock
* aquisition. By taking the lock it is ensured that such a newly * acquisition. By taking the lock it is ensured that such a newly
* enqueued timer is dequeued and cannot end up with * enqueued timer is dequeued and cannot end up with
* timer->function == NULL in the expiry code. * timer->function == NULL in the expiry code.
* *
...@@ -2306,7 +2306,7 @@ static inline u64 __get_next_timer_interrupt(unsigned long basej, u64 basem, ...@@ -2306,7 +2306,7 @@ static inline u64 __get_next_timer_interrupt(unsigned long basej, u64 basem,
/* /*
* When timer base is not set idle, undo the effect of * When timer base is not set idle, undo the effect of
* tmigr_cpu_deactivate() to prevent inconsitent states - active * tmigr_cpu_deactivate() to prevent inconsistent states - active
* timer base but inactive timer migration hierarchy. * timer base but inactive timer migration hierarchy.
* *
* When timer base was already marked idle, nothing will be * When timer base was already marked idle, nothing will be
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment