[PATCH v3] spi: spi-cadence: Add missing kernel doc for clk_rate in cdns_spi

[PATCH v3] spi: spi-cadence: Add missing kernel doc for clk_rate in cdns_spi

[Charles Keepax]

Add the missing kernel documentation to silence the build warning.

Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
---

Just splitting the patch out to fix my omitting v2 in the title.

Thanks,
Charles

 drivers/spi/spi-cadence.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/spi/spi-cadence.c b/drivers/spi/spi-cadence.c
index 26e6633693196..de8fe3c5becbb 100644
--- a/drivers/spi/spi-cadence.c
+++ b/drivers/spi/spi-cadence.c
@@ -102,6 +102,7 @@
  * @regs:		Virtual address of the SPI controller registers
  * @ref_clk:		Pointer to the peripheral clock
  * @pclk:		Pointer to the APB clock
+ * @clk_rate:		Reference clock frequency, taken from @ref_clk
  * @speed_hz:		Current SPI bus clock speed in Hz
  * @txbuf:		Pointer	to the TX buffer
  * @rxbuf:		Pointer to the RX buffer
-- 
2.30.2

Re: [PATCH v3] spi: spi-cadence: Add missing kernel doc for clk_rate in cdns_spi

[Mark Brown]

On Tue, 23 May 2023 10:01:24 +0100, Charles Keepax wrote:
> Add the missing kernel documentation to silence the build warning.
> 
> 

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-next

Thanks!

[1/1] spi: spi-cadence: Add missing kernel doc for clk_rate in cdns_spi
      commit: b6e4686ca8c3932ed0eee66c016c05c870e44f5d

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark