diff mbox series

[10/16] i2c: busses: i2c-ocores: Place the expected function names into the documentation headers

Message ID 20210520190105.3772683-11-lee.jones@linaro.org
State Accepted
Commit d4c73d41bef08f6d7878cb3e55d7e50df13d02c1
Headers show
Series Rid W=1 warnings from I2C | expand

Commit Message

Lee Jones May 20, 2021, 7 p.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/i2c/busses/i2c-ocores.c:253: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/i2c/busses/i2c-ocores.c:267: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/i2c/busses/i2c-ocores.c:299: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/i2c/busses/i2c-ocores.c:347: warning: expecting prototype for It handles an IRQ(). Prototype was for ocores_process_polling() instead

Cc: Peter Korsgaard <peter@korsgaard.com>
Cc: Andrew Lunn <andrew@lunn.ch>
Cc: Palmer Dabbelt <palmer@dabbelt.com>
Cc: Paul Walmsley <paul.walmsley@sifive.com>
Cc: Andreas Larsson <andreas@gaisler.com>
Cc: linux-i2c@vger.kernel.org
Cc: linux-riscv@lists.infradead.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/i2c/busses/i2c-ocores.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

-- 
2.31.1

Comments

Andrew Lunn May 20, 2021, 7:12 p.m. UTC | #1
On Thu, May 20, 2021 at 08:00:59PM +0100, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/i2c/busses/i2c-ocores.c:253: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

>  drivers/i2c/busses/i2c-ocores.c:267: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

>  drivers/i2c/busses/i2c-ocores.c:299: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

>  drivers/i2c/busses/i2c-ocores.c:347: warning: expecting prototype for It handles an IRQ(). Prototype was for ocores_process_polling() instead

> 

> Cc: Peter Korsgaard <peter@korsgaard.com>

> Cc: Andrew Lunn <andrew@lunn.ch>

> Cc: Palmer Dabbelt <palmer@dabbelt.com>

> Cc: Paul Walmsley <paul.walmsley@sifive.com>

> Cc: Andreas Larsson <andreas@gaisler.com>

> Cc: linux-i2c@vger.kernel.org

> Cc: linux-riscv@lists.infradead.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>


Reviewed-by: Andrew Lunn <andrew@lunn.ch>


    Andrew
Peter Korsgaard May 20, 2021, 8:21 p.m. UTC | #2
>>>>> "Lee" == Lee Jones <lee.jones@linaro.org> writes:


 > Fixes the following W=1 kernel build warning(s):

 >  drivers/i2c/busses/i2c-ocores.c:253: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

 >  drivers/i2c/busses/i2c-ocores.c:267: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

 >  drivers/i2c/busses/i2c-ocores.c:299: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

 >  drivers/i2c/busses/i2c-ocores.c:347: warning: expecting prototype for It handles an IRQ(). Prototype was for ocores_process_polling() instead


 > Cc: Peter Korsgaard <peter@korsgaard.com>

 > Cc: Andrew Lunn <andrew@lunn.ch>

 > Cc: Palmer Dabbelt <palmer@dabbelt.com>

 > Cc: Paul Walmsley <paul.walmsley@sifive.com>

 > Cc: Andreas Larsson <andreas@gaisler.com>

 > Cc: linux-i2c@vger.kernel.org

 > Cc: linux-riscv@lists.infradead.org

 > Signed-off-by: Lee Jones <lee.jones@linaro.org>


Reviewed-by: Peter Korsgaard <peter@korsgaard.com>


-- 
Bye, Peter Korsgaard
Wolfram Sang May 27, 2021, 7:33 p.m. UTC | #3
On Thu, May 20, 2021 at 08:00:59PM +0100, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/i2c/busses/i2c-ocores.c:253: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

>  drivers/i2c/busses/i2c-ocores.c:267: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

>  drivers/i2c/busses/i2c-ocores.c:299: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

>  drivers/i2c/busses/i2c-ocores.c:347: warning: expecting prototype for It handles an IRQ(). Prototype was for ocores_process_polling() instead

> 

> Cc: Peter Korsgaard <peter@korsgaard.com>

> Cc: Andrew Lunn <andrew@lunn.ch>

> Cc: Palmer Dabbelt <palmer@dabbelt.com>

> Cc: Paul Walmsley <paul.walmsley@sifive.com>

> Cc: Andreas Larsson <andreas@gaisler.com>

> Cc: linux-i2c@vger.kernel.org

> Cc: linux-riscv@lists.infradead.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>


Applied to for-current, thanks!
diff mbox series

Patch

diff --git a/drivers/i2c/busses/i2c-ocores.c b/drivers/i2c/busses/i2c-ocores.c
index 273222e38056e..a0af027db04c1 100644
--- a/drivers/i2c/busses/i2c-ocores.c
+++ b/drivers/i2c/busses/i2c-ocores.c
@@ -250,7 +250,7 @@  static irqreturn_t ocores_isr(int irq, void *dev_id)
 }
 
 /**
- * Process timeout event
+ * ocores_process_timeout() - Process timeout event
  * @i2c: ocores I2C device instance
  */
 static void ocores_process_timeout(struct ocores_i2c *i2c)
@@ -264,7 +264,7 @@  static void ocores_process_timeout(struct ocores_i2c *i2c)
 }
 
 /**
- * Wait until something change in a given register
+ * ocores_wait() - Wait until something change in a given register
  * @i2c: ocores I2C device instance
  * @reg: register to query
  * @mask: bitmask to apply on register value
@@ -296,7 +296,7 @@  static int ocores_wait(struct ocores_i2c *i2c,
 }
 
 /**
- * Wait until is possible to process some data
+ * ocores_poll_wait() - Wait until is possible to process some data
  * @i2c: ocores I2C device instance
  *
  * Used when the device is in polling mode (interrupts disabled).
@@ -334,7 +334,7 @@  static int ocores_poll_wait(struct ocores_i2c *i2c)
 }
 
 /**
- * It handles an IRQ-less transfer
+ * ocores_process_polling() - It handles an IRQ-less transfer
  * @i2c: ocores I2C device instance
  *
  * Even if IRQ are disabled, the I2C OpenCore IP behavior is exactly the same