[RFC] i2c: ocores: turn incomplete kdoc into a comment

Message ID 20190211103728.22959-1-wsa@the-dreams.de
State New
Headers show
Series
  • [RFC] i2c: ocores: turn incomplete kdoc into a comment
Related show

Commit Message

Wolfram Sang Feb. 11, 2019, 10:37 a.m.
gcc complains, rightfully so, I think:

drivers/i2c/busses/i2c-ocores.c:32: warning: Cannot understand  * @process_lock: protect I2C transfer process.
 on line 32 - I thought it was a doc line

Make it a simple comment.

Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
---

Of course, if someone wants to provide a full kerneldoc, I am all for it.

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

Comments

Federico Vaga Feb. 12, 2019, 8:41 a.m. | #1
On Monday, February 11, 2019 11:37:28 AM CET Wolfram Sang wrote:
> gcc complains, rightfully so, I think:
> 
> drivers/i2c/busses/i2c-ocores.c:32: warning: Cannot understand  *
> @process_lock: protect I2C transfer process. on line 32 - I thought it was
> a doc line
> 
> Make it a simple comment.

For me it's fine.

> 
> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
> ---
> 
> Of course, if someone wants to provide a full kerneldoc, I am all for it.
> 
>  drivers/i2c/busses/i2c-ocores.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/i2c/busses/i2c-ocores.c
> b/drivers/i2c/busses/i2c-ocores.c index 738e6314b2be..8f9c86485dec 100644
> --- a/drivers/i2c/busses/i2c-ocores.c
> +++ b/drivers/i2c/busses/i2c-ocores.c
> @@ -28,9 +28,9 @@
> 
>  #define OCORES_FLAG_POLL BIT(0)
> 
> -/**
> - * @process_lock: protect I2C transfer process.
> - *     ocores_process() and ocores_process_timeout() can't run in parallel.
> +/*
> + * 'process_lock' exists because ocores_process() and
> ocores_process_timeout() + * can't run in parallel.
>   */
>  struct ocores_i2c {
>  	void __iomem *base;

Patch

diff --git a/drivers/i2c/busses/i2c-ocores.c b/drivers/i2c/busses/i2c-ocores.c
index 738e6314b2be..8f9c86485dec 100644
--- a/drivers/i2c/busses/i2c-ocores.c
+++ b/drivers/i2c/busses/i2c-ocores.c
@@ -28,9 +28,9 @@ 
 
 #define OCORES_FLAG_POLL BIT(0)
 
-/**
- * @process_lock: protect I2C transfer process.
- *     ocores_process() and ocores_process_timeout() can't run in parallel.
+/*
+ * 'process_lock' exists because ocores_process() and ocores_process_timeout()
+ * can't run in parallel.
  */
 struct ocores_i2c {
 	void __iomem *base;