public inbox for linux-i2c@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] i2c: rk3x: add proper kerneldoc header
@ 2018-01-17 23:18 Wolfram Sang
  2018-01-17 23:19 ` Heiko Stuebner
  2018-01-17 23:31 ` Wolfram Sang
  0 siblings, 2 replies; 3+ messages in thread
From: Wolfram Sang @ 2018-01-17 23:18 UTC (permalink / raw)
  To: linux-i2c; +Cc: linux-rockchip, Heiko Stuebner, Wolfram Sang

gcc noticed the kerneldoc was wrongly formatted. Fix it!

drivers/i2c/busses/i2c-rk3x.c:164: warning:
  Cannot understand  * @grf_offset: ...
  on line 164 - I thought it was a doc line

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

It also found this, but I leave this for now. Maybe someone else is interested:

drivers/i2c/busses/i2c-rk3x.c:247: warning: No description found for parameter 'i2c'
drivers/i2c/busses/i2c-rk3x.c:268: warning: No description found for parameter 'i2c'
drivers/i2c/busses/i2c-rk3x.c:306: warning: No description found for parameter 'i2c'
drivers/i2c/busses/i2c-rk3x.c:337: warning: No description found for parameter 'i2c'
drivers/i2c/busses/i2c-rk3x.c:975: warning: No description found for parameter 'i2c'

 drivers/i2c/busses/i2c-rk3x.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/i2c/busses/i2c-rk3x.c b/drivers/i2c/busses/i2c-rk3x.c
index 1f80960c5ae1c8..e1a18d989f8307 100644
--- a/drivers/i2c/busses/i2c-rk3x.c
+++ b/drivers/i2c/busses/i2c-rk3x.c
@@ -161,6 +161,7 @@ enum rk3x_i2c_state {
 };
 
 /**
+ * struct rk3x_i2c_soc_data:
  * @grf_offset: offset inside the grf regmap for setting the i2c type
  * @calc_timings: Callback function for i2c timing information calculated
  */
-- 
2.11.0

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] i2c: rk3x: add proper kerneldoc header
  2018-01-17 23:18 [PATCH] i2c: rk3x: add proper kerneldoc header Wolfram Sang
@ 2018-01-17 23:19 ` Heiko Stuebner
  2018-01-17 23:31 ` Wolfram Sang
  1 sibling, 0 replies; 3+ messages in thread
From: Heiko Stuebner @ 2018-01-17 23:19 UTC (permalink / raw)
  To: Wolfram Sang; +Cc: linux-i2c, linux-rockchip

Am Donnerstag, 18. Januar 2018, 00:18:17 CET schrieb Wolfram Sang:
> gcc noticed the kerneldoc was wrongly formatted. Fix it!
> 
> drivers/i2c/busses/i2c-rk3x.c:164: warning:
>   Cannot understand  * @grf_offset: ...
>   on line 164 - I thought it was a doc line
> 
> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>

If you need it,
Reviewed-by: Heiko Stuebner <heiko@sntech.de>

> ---
> 
> It also found this, but I leave this for now. Maybe someone else is interested:
> 
> drivers/i2c/busses/i2c-rk3x.c:247: warning: No description found for parameter 'i2c'
> drivers/i2c/busses/i2c-rk3x.c:268: warning: No description found for parameter 'i2c'
> drivers/i2c/busses/i2c-rk3x.c:306: warning: No description found for parameter 'i2c'
> drivers/i2c/busses/i2c-rk3x.c:337: warning: No description found for parameter 'i2c'
> drivers/i2c/busses/i2c-rk3x.c:975: warning: No description found for parameter 'i2c'
> 
>  drivers/i2c/busses/i2c-rk3x.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/i2c/busses/i2c-rk3x.c b/drivers/i2c/busses/i2c-rk3x.c
> index 1f80960c5ae1c8..e1a18d989f8307 100644
> --- a/drivers/i2c/busses/i2c-rk3x.c
> +++ b/drivers/i2c/busses/i2c-rk3x.c
> @@ -161,6 +161,7 @@ enum rk3x_i2c_state {
>  };
>  
>  /**
> + * struct rk3x_i2c_soc_data:
>   * @grf_offset: offset inside the grf regmap for setting the i2c type
>   * @calc_timings: Callback function for i2c timing information calculated
>   */
> 

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] i2c: rk3x: add proper kerneldoc header
  2018-01-17 23:18 [PATCH] i2c: rk3x: add proper kerneldoc header Wolfram Sang
  2018-01-17 23:19 ` Heiko Stuebner
@ 2018-01-17 23:31 ` Wolfram Sang
  1 sibling, 0 replies; 3+ messages in thread
From: Wolfram Sang @ 2018-01-17 23:31 UTC (permalink / raw)
  To: linux-i2c; +Cc: linux-rockchip, Heiko Stuebner

[-- Attachment #1: Type: text/plain, Size: 353 bytes --]

On Thu, Jan 18, 2018 at 12:18:17AM +0100, Wolfram Sang wrote:
> gcc noticed the kerneldoc was wrongly formatted. Fix it!
> 
> drivers/i2c/busses/i2c-rk3x.c:164: warning:
>   Cannot understand  * @grf_offset: ...
>   on line 164 - I thought it was a doc line
> 
> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>

Applied to for-next, thanks!


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2018-01-17 23:31 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-01-17 23:18 [PATCH] i2c: rk3x: add proper kerneldoc header Wolfram Sang
2018-01-17 23:19 ` Heiko Stuebner
2018-01-17 23:31 ` Wolfram Sang

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox