Skip to contentSkip to conversation

ptp: fix struct member comment for do_aux_work

PATCH Applied Jacob Keller 3 participants 3 messages May 11, 2020 – May 12, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ptp: fix struct member comment for do_aux_work

The do_aux_work callback had documentation in the structure comment which referred to it as "do_work".

Cc Richard Cochran <[email protected]>
---
 include/linux/ptp_clock_kernel.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
include/linux/ptp_clock_kernel.h +4 -4
index 31144d954d89..d3e8ba5c7125 100644
@@ -108,10 +108,10 @@ struct ptp_system_timestamp {
  *            parameter func: the desired function to use.
  *            parameter chan: the function channel index to use.
  *
- * @do_work:  Request driver to perform auxiliary (periodic) operations
- *	      Driver should return delay of the next auxiliary work scheduling
- *	      time (>=0) or negative value in case further scheduling
- *	      is not required.
+ * @do_aux_work:  Request driver to perform auxiliary (periodic) operations
+ *                Driver should return delay of the next auxiliary work
+ *                scheduling time (>=0) or negative value in case further
+ *                scheduling is not required.
  *
  * Drivers should embed their ptp_clock_info within a private
  * structure, obtaining a reference to it using container_of().
Signature · 1 line
2.25.2