Skip to contentSkip to conversation

alarmtimer: fixed comments describing structure fields

PATCH Applied Pratyush Patel 2 participants 2 messages Jun 14, 2016 – Jun 17, 2016

Subsystems (2)
Kernel janitors Timekeeping, clocksource core, NTP, alarmtimer
lore
Share & tools
lore

Pratyush Patel

author
#0 lore raw

PATCH 1/1 alarmtimer: fixed comments describing structure fields

Updated struct alarm and struct alarm_timer descriptions.

Signed-off-by Pratyush Patel <[email protected]>
---
 include/linux/alarmtimer.h | 6 +++---
 kernel/time/alarmtimer.c   | 1 -
 2 files changed, 3 insertions(+), 4 deletions(-)
include/linux/alarmtimer.h +3 -3
index 52f3b7d..9d80312 100644
@@ -26,10 +26,10 @@ enum alarmtimer_restart {
  * struct alarm - Alarm timer structure
  * @node:	timerqueue node for adding to the event list this value
  *		also includes the expiration time.
- * @period:	Period for recuring alarms
+ * @timer:	hrtimer used to schedule events while running
  * @function:	Function pointer to be executed when the timer fires.
- * @type:	Alarm type (BOOTTIME/REALTIME)
- * @enabled:	Flag that represents if the alarm is set to fire or not
+ * @type:	Alarm type (BOOTTIME/REALTIME).
+ * @state:	Flag that represents if the alarm is set to fire or not.
  * @data:	Internal data value.
  */
 struct alarm {
kernel/time/alarmtimer.c +0 -1
index e840ed8..c3aad68 100644
@@ -30,7 +30,6 @@
  * struct alarm_base - Alarm timer bases
  * @lock:		Lock for syncrhonized access to the base
  * @timerqueue:		Timerqueue head managing the list of events
- * @timer: 		hrtimer used to schedule events while running
  * @gettime:		Function to read the time correlating to the base
  * @base_clockid:	clockid for the base
  */
Signature · 1 line
2.7.4