From: Thomas Gleixner Date: Mon, 20 Oct 2008 14:38:19 +0000 (+0200) Subject: hrtimers: add missing docbook comments to struct hrtimer X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=592aa999d6a272856c9bfbdaac0cfba1bb37c24c;p=mv-sheeva.git hrtimers: add missing docbook comments to struct hrtimer Signed-off-by: Thomas Gleixner --- diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h index cb25c1cc235..58bca8e9bae 100644 --- a/include/linux/hrtimer.h +++ b/include/linux/hrtimer.h @@ -103,9 +103,14 @@ enum hrtimer_cb_mode { /** * struct hrtimer - the basic hrtimer structure * @node: red black tree node for time ordered insertion - * @expires: the absolute expiry time in the hrtimers internal + * @_expires: the absolute expiry time in the hrtimers internal * representation. The time is related to the clock on - * which the timer is based. + * which the timer is based. Is setup by adding + * slack to the _softexpires value. For non range timers + * identical to _softexpires. + * @_softexpires: the absolute earliest expiry time of the hrtimer. + * The time which was given as expiry time when the timer + * was armed. * @function: timer expiry callback function * @base: pointer to the timer base (per cpu and per clock) * @state: state information (See bit values above)