net: cavium: Fix a bunch of kerneldoc parameter issues
Subsystems (2)
PATCH 1/1 net: cavium: Fix a bunch of kerneldoc parameter issues
Rename ptp to ptp_info.
Fix W=1 compile warnings (invalid kerneldoc):
drivers/net/ethernet/cavium/common/cavium_ptp.c:94: warning: Excess function parameter 'ptp' description in 'cavium_ptp_adjfine' drivers/net/ethernet/cavium/common/cavium_ptp.c:141: warning: Excess function parameter 'ptp' description in 'cavium_ptp_adjtime' drivers/net/ethernet/cavium/common/cavium_ptp.c:163: warning: Excess function parameter 'ptp' description in 'cavium_ptp_gettime' drivers/net/ethernet/cavium/common/cavium_ptp.c:185: warning: Excess function parameter 'ptp' description in 'cavium_ptp_settime' drivers/net/ethernet/cavium/common/cavium_ptp.c:208: warning: Excess function parameter 'ptp' description in 'cavium_ptp_enable'
--- drivers/net/ethernet/cavium/common/cavium_ptp.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/net/ethernet/cavium/common/cavium_ptp.c +5 -5
@@ -86,7 +86,7 @@ EXPORT_SYMBOL(cavium_ptp_put);/** * cavium_ptp_adjfine() - Adjust ptp frequency -* @ptp: PTP clock info +* @ptp_info: PTP clock info * @scaled_ppm: how much to adjust by, in parts per million, but with a * 16 bit binary fractional field */
@@ -134,7 +134,7 @@ static int cavium_ptp_adjfine(struct ptp_clock_info *ptp_info, long scaled_ppm)/** * cavium_ptp_adjtime() - Adjust ptp time -* @ptp: PTP clock info +* @ptp_info: PTP clock info * @delta: how much to adjust by, in nanosecs */ static int cavium_ptp_adjtime (struct ptp_clock_info *ptp_info,s64 delta)
@@ -155,7 +155,7 @@ static int cavium_ptp_adjtime(struct ptp_clock_info *ptp_info, s64 delta)/** * cavium_ptp_gettime() - Get hardware clock time with adjustment -* @ptp: PTP clock info +* @ptp_info: PTP clock info * @ts: timespec */ static int cavium_ptp_gettime(struct ptp_clock_info *ptp_info,
@@ -177,7 +177,7 @@ static int cavium_ptp_gettime(struct ptp_clock_info *ptp_info,/** * cavium_ptp_settime() - Set hardware clock time. Reset adjustment -* @ptp: PTP clock info +* @ptp_info: PTP clock info * @ts: timespec */ static int cavium_ptp_settime(struct ptp_clock_info *ptp_info,
@@ -199,7 +199,7 @@ static int cavium_ptp_settime(struct ptp_clock_info *ptp_info,/** * cavium_ptp_enable() - Request to enable or disable an ancillary feature. -* @ptp: PTP clock info +* @ptp_info: PTP clock info * @rq: request * @on: is it on */
Signature · 1 line
2.17.1
From: Wang Hai <[email protected]>
Date: Wed, 9 Sep 2020 21:21:09 +0800
Quoted 4 lines
Rename ptp to
ptp_info.Fix W=1 compile warnings (invalid kerneldoc):
Quoted 8 lines
drivers/net/ethernet/cavium/common/cavium_ptp.c:94: warning: Excess function parameter 'ptp' description in 'cavium_ptp_adjfine'drivers/net/ethernet/cavium/common/cavium_ptp.c:141: warning: Excess function parameter 'ptp' description in 'cavium_ptp_adjtime'drivers/net/ethernet/cavium/common/cavium_ptp.c:163: warning: Excess function parameter 'ptp' description in 'cavium_ptp_gettime'drivers/net/ethernet/cavium/common/cavium_ptp.c:185: warning: Excess function parameter 'ptp' description in 'cavium_ptp_settime'drivers/net/ethernet/cavium/common/cavium_ptp.c:208: warning: Excess function parameter 'ptp' description in 'cavium_ptp_enable'Reported-by Hulk Robot <[email protected]>Signed-off-by Wang Hai <[email protected]>
Applied, thanks.