[prev in list] [next in list] [prev in thread] [next in thread] 

List:       git-commits-head
Subject:    i2c: busses: i2c-ocores: Place the expected function names into the documentation headers
From:       Linux Kernel Mailing List <linux-kernel () vger ! kernel ! org>
Date:       2021-05-30 4:30:34
Message-ID: git-mailbomb-linux-master-d4c73d41bef08f6d7878cb3e55d7e50df13d02c1 () kernel ! org
[Download RAW message or body]

Commit:     d4c73d41bef08f6d7878cb3e55d7e50df13d02c1
Parent:     f9f193fc222bd5352a414ba34406303cfedd2c5e
Refname:    refs/heads/master
Web:        https://git.kernel.org/torvalds/c/d4c73d41bef08f6d7878cb3e55d7e50df13d02c1
                
Author:     Lee Jones <lee.jones@linaro.org>
AuthorDate: Thu May 20 20:00:59 2021 +0100
Committer:  Wolfram Sang <wsa@kernel.org>
CommitDate: Thu May 27 21:33:41 2021 +0200

    i2c: busses: i2c-ocores: Place the expected function names into the documentation \
headers  
    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  
    Signed-off-by: Lee Jones <lee.jones@linaro.org>
    Reviewed-by: Andrew Lunn <andrew@lunn.ch>
    Reviewed-by: Peter Korsgaard <peter@korsgaard.com>
    Signed-off-by: Wolfram Sang <wsa@kernel.org>
---
 drivers/i2c/busses/i2c-ocores.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

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


[prev in list] [next in list] [prev in thread] [next in thread]