Skip to contentSkip to conversation

timekeeping: Fix typo

PATCH Applied Kurt Kanzenbach 2 participants 2 messages Jun 9, 2020 – Jun 18, 2020 Timekeeping, clocksource core, NTP, alarmtimer

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 timekeeping: Fix typo

Fix typo in comment for cross timestamping structure:

syncronized -> synchronized.

---
 include/linux/timekeeping.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/timekeeping.h +1 -1
index b27e2ffa96c1..17a1a2b6be40 100644
@@ -241,7 +241,7 @@ struct system_time_snapshot {
 
 /*
  * struct system_device_crosststamp - system/device cross-timestamp
- *	(syncronized capture)
+ *	(synchronized capture)
  * @device:		Device time
  * @sys_realtime:	Realtime simultaneous with device time
  * @sys_monoraw:	Monotonic raw simultaneous with device time
Signature · 1 line
2.20.1
#1 lore raw

[tip: timers/urgent] timekeeping: Fix kerneldoc system_device_crosststamp & al

The following commit has been merged into the timers/urgent branch of tip:

The following commit has been merged into the timers/urgent branch of tip:

Commit-ID:     f097eb38f71391ff2cf078788bad5a00eb3bd96a
Gitweb:        https://git.kernel.org/tip/f097eb38f71391ff2cf078788bad5a00eb3bd96a
Author:        Kurt Kanzenbach <[email protected]>
AuthorDate:    Tue, 09 Jun 2020 10:17:26 +02:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Thu, 18 Jun 2020 11:37:03 +02:00

timekeeping: Fix kerneldoc system_device_crosststamp & al

Make kernel doc comments actually work and fix the syncronized typo.

[ tglx: Added the missing /** and fixed up formatting ]

---
 include/linux/timekeeping.h | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
include/linux/timekeeping.h +7 -7
index b27e2ff..d5471d6 100644
@@ -222,9 +222,9 @@ extern bool timekeeping_rtc_skipresume(void);
 
 extern void timekeeping_inject_sleeptime64(const struct timespec64 *delta);
 
-/*
+/**
  * struct system_time_snapshot - simultaneous raw/real time capture with
- *	counter value
+ *				 counter value
  * @cycles:	Clocksource counter value to produce the system times
  * @real:	Realtime system time
  * @raw:	Monotonic raw system time
@@ -239,9 +239,9 @@ struct system_time_snapshot {
 	u8		cs_was_changed_seq;
 };
 
-/*
+/**
  * struct system_device_crosststamp - system/device cross-timestamp
- *	(syncronized capture)
+ *				      (synchronized capture)
  * @device:		Device time
  * @sys_realtime:	Realtime simultaneous with device time
  * @sys_monoraw:	Monotonic raw simultaneous with device time
@@ -252,12 +252,12 @@ struct system_device_crosststamp {
 	ktime_t sys_monoraw;
 };
 
-/*
+/**
  * struct system_counterval_t - system counter value with the pointer to the
- *	corresponding clocksource
+ *				corresponding clocksource
  * @cycles:	System counter value
  * @cs:		Clocksource corresponding to system counter value. Used by
- *	timekeeping code to verify comparibility of two cycle values
+ *		timekeeping code to verify comparibility of two cycle values
  */
 struct system_counterval_t {
 	u64			cycles;