RE: [PATCH 2/2] spi: spi-cadence: Fix kernel-doc format for resume/suspend

From: Amit Kumar Kumar Mahapatra
Date: Fri Mar 11 2022 - 06:33:17 EST


Hello Mark,

> -----Original Message-----
> From: Mark Brown <broonie@xxxxxxxxxx>
> Sent: Friday, March 11, 2022 12:17 AM
> To: Amit Kumar Kumar Mahapatra <akumarma@xxxxxxxxxx>
> Cc: linux-spi@xxxxxxxxxxxxxxx; linux-kernel@xxxxxxxxxxxxxxx; git
> <git@xxxxxxxxxx>; Amit Kumar Kumar Mahapatra <akumarma@xxxxxxxxxx>;
> Michal Simek <michals@xxxxxxxxxx>
> Subject: Re: [PATCH 2/2] spi: spi-cadence: Fix kernel-doc format for
> resume/suspend
>
> On Thu, Mar 10, 2022 at 10:12:35PM +0530, Amit Kumar Mahapatra wrote:
> > From: Michal Simek <michal.simek@xxxxxxxxxx>
> >
> > Kernel function name don't match with function name.
> >
> > Error log:
> > drivers/spi/spi-cadence.c:662: warning: expecting prototype for
> > cdns_spi_runtime_resume(). Prototype was for cnds_runtime_resume()
> > instead
> > drivers/spi/spi-cadence.c:691: warning: expecting prototype for
> > cdns_spi_runtime_suspend(). Prototype was for cnds_runtime_suspend()
> > instead
>
> These errors are introduced by the prior patch in the series, that patch
> should be fixed to just not introduce these errors in the first place.

https://github.com/torvalds/linux/commit/d36ccd9f7ea41f343391a15677b8a858376e1107
The above patch introduced two issues. as mentioned below
1) Runtime suspend/resume API had "cnds" prefix, unlike all other driver APIs
that has "cdns" prefix
2) kernel-doc warnings in runtime suspend/resume APIs.

So, the runtime suspend/resume kernel-doc warnings were present prior to this
patch series and were not introduced in the 1/2 patch of this series.

1/2 patch of this series aligns the runtime suspend/resume API prefix with the
rest of the functions by changing it from "cnds" to "cdns".
2/2 patch of this series fixes the kernel-doc warning in runtime suspend/resume
APIs.

Regards,
Amit