Commit 6e5a9190 authored by Alex Shi's avatar Alex Shi Committed by Thomas Gleixner

timekeeping: Address parameter documentation issues for various functions

The kernel-doc parser complains:

 kernel/time/timekeeping.c:1543: warning: Function parameter or member
 'ts' not described in 'read_persistent_clock64'

 kernel/time/timekeeping.c:764: warning: Function parameter or member
 'tk' not described in 'timekeeping_forward_now'

 kernel/time/timekeeping.c:1331: warning: Function parameter or member
 'ts' not described in 'timekeeping_inject_offset'

 kernel/time/timekeeping.c:1331: warning: Excess function parameter 'tv'
 description in 'timekeeping_inject_offset'

Add the missing parameter documentations and rename the 'tv' parameter of
timekeeping_inject_offset() to 'ts' so it matches the implemention.

[ tglx: Reworded a few docs and massaged changelog ]
Signed-off-by: default avatarAlex Shi <alex.shi@linux.alibaba.com>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/1605252275-63652-5-git-send-email-alex.shi@linux.alibaba.com
parent 29efc461
...@@ -774,6 +774,7 @@ static void timekeeping_update(struct timekeeper *tk, unsigned int action) ...@@ -774,6 +774,7 @@ static void timekeeping_update(struct timekeeper *tk, unsigned int action)
/** /**
* timekeeping_forward_now - update clock to the current time * timekeeping_forward_now - update clock to the current time
* @tk: Pointer to the timekeeper to update
* *
* Forward the current clock to update its state since the last call to * Forward the current clock to update its state since the last call to
* update_wall_time(). This is useful before significant clock changes, * update_wall_time(). This is useful before significant clock changes,
...@@ -1350,7 +1351,7 @@ EXPORT_SYMBOL(do_settimeofday64); ...@@ -1350,7 +1351,7 @@ EXPORT_SYMBOL(do_settimeofday64);
/** /**
* timekeeping_inject_offset - Adds or subtracts from the current time. * timekeeping_inject_offset - Adds or subtracts from the current time.
* @tv: pointer to the timespec variable containing the offset * @ts: Pointer to the timespec variable containing the offset
* *
* Adds or subtracts an offset value from the current time. * Adds or subtracts an offset value from the current time.
*/ */
...@@ -1558,6 +1559,7 @@ u64 timekeeping_max_deferment(void) ...@@ -1558,6 +1559,7 @@ u64 timekeeping_max_deferment(void)
/** /**
* read_persistent_clock64 - Return time from the persistent clock. * read_persistent_clock64 - Return time from the persistent clock.
* @ts: Pointer to the storage for the readout value
* *
* Weak dummy function for arches that do not yet support it. * Weak dummy function for arches that do not yet support it.
* Reads the time from the battery backed persistent clock. * Reads the time from the battery backed persistent clock.
...@@ -1663,7 +1665,8 @@ static struct timespec64 timekeeping_suspend_time; ...@@ -1663,7 +1665,8 @@ static struct timespec64 timekeeping_suspend_time;
/** /**
* __timekeeping_inject_sleeptime - Internal function to add sleep interval * __timekeeping_inject_sleeptime - Internal function to add sleep interval
* @delta: pointer to a timespec delta value * @tk: Pointer to the timekeeper to be updated
* @delta: Pointer to the delta value in timespec64 format
* *
* Takes a timespec offset measuring a suspend interval and properly * Takes a timespec offset measuring a suspend interval and properly
* adds the sleep offset to the timekeeping variables. * adds the sleep offset to the timekeeping variables.
......
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