[PATCH net] ptp: fix struct member comment for do_aux_work

[PATCH net] ptp: fix struct member comment for do_aux_work

[Jacob Keller]

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

Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
Cc: Richard Cochran <richardcochran@gmail.com>
---
 include/linux/ptp_clock_kernel.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/ptp_clock_kernel.h b/include/linux/ptp_clock_kernel.h
index 31144d954d89..d3e8ba5c7125 100644
--- a/include/linux/ptp_clock_kernel.h
+++ b/include/linux/ptp_clock_kernel.h
@@ -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().
-- 
2.25.2

Re: [PATCH net] ptp: fix struct member comment for do_aux_work

[Richard Cochran]

On Mon, May 11, 2020 at 02:02:15PM -0700, Jacob Keller wrote:
> The do_aux_work callback had documentation in the structure comment
> which referred to it as "do_work".
> 
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
> Cc: Richard Cochran <richardcochran@gmail.com>

Thanks, Jacob, for cleaning this up!

Acked-by: Richard Cochran <richardcochran@gmail.com>

Re: [PATCH net] ptp: fix struct member comment for do_aux_work

[David Miller]

From: Jacob Keller <jacob.e.keller@intel.com>
Date: Mon, 11 May 2020 14:02:15 -0700

> The do_aux_work callback had documentation in the structure comment
> which referred to it as "do_work".
> 
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>

Applied, thanks.