alarmtimer: Fix comments describing structure fields

Updated struct alarm and struct alarm_timer descriptions.

Cc: Prarit Bhargava <prarit@redhat.com>
Cc: Richard Cochran <richardcochran@gmail.com>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Ingo Molnar <mingo@kernel.org>
Signed-off-by: Pratyush Patel <pratyushpatel.1995@gmail.com>
Signed-off-by: John Stultz <john.stultz@linaro.org>

diff --git a/include/linux/alarmtimer.h b/include/linux/alarmtimer.h
index 52f3b7da4f2d4dbb181aa1fe5c8d73e4df8f1814..9d8031257a90d8a371b27b608f8e8fbf532bf974 100644 (file)
--- a/include/linux/alarmtimer.h
+++ b/include/linux/alarmtimer.h
@@ -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 {

diff --git a/kernel/time/alarmtimer.c b/kernel/time/alarmtimer.c
index e840ed867a5d9406e26a8bc13f3e635b0d66cbdd..c3aad685bbc036cc2f03672085aedd9dc9c8fb86 100644 (file)
--- a/kernel/time/alarmtimer.c
+++ b/kernel/time/alarmtimer.c
@@ -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
  */