From: Lee Jones <lee.jones@linaro.org> To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Peter Korsgaard <peter@korsgaard.com>, Andrew Lunn <andrew@lunn.ch>, Palmer Dabbelt <palmer@dabbelt.com>, Paul Walmsley <paul.walmsley@sifive.com>, Andreas Larsson <andreas@gaisler.com>, linux-i2c@vger.kernel.org, linux-riscv@lists.infradead.org Subject: [PATCH 10/16] i2c: busses: i2c-ocores: Place the expected function names into the documentation headers Date: Thu, 20 May 2021 20:00:59 +0100 [thread overview] Message-ID: <20210520190105.3772683-11-lee.jones@linaro.org> (raw) In-Reply-To: <20210520190105.3772683-1-lee.jones@linaro.org> 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(-) 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 -- 2.31.1
WARNING: multiple messages have this Message-ID (diff)
From: Lee Jones <lee.jones@linaro.org> To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Peter Korsgaard <peter@korsgaard.com>, Andrew Lunn <andrew@lunn.ch>, Palmer Dabbelt <palmer@dabbelt.com>, Paul Walmsley <paul.walmsley@sifive.com>, Andreas Larsson <andreas@gaisler.com>, linux-i2c@vger.kernel.org, linux-riscv@lists.infradead.org Subject: [PATCH 10/16] i2c: busses: i2c-ocores: Place the expected function names into the documentation headers Date: Thu, 20 May 2021 20:00:59 +0100 [thread overview] Message-ID: <20210520190105.3772683-11-lee.jones@linaro.org> (raw) In-Reply-To: <20210520190105.3772683-1-lee.jones@linaro.org> 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(-) 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 -- 2.31.1 _______________________________________________ linux-riscv mailing list linux-riscv@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-riscv
next prev parent reply other threads:[~2021-05-20 19:01 UTC|newest] Thread overview: 91+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-05-20 19:00 [PATCH 00/16] Rid W=1 warnings from I2C Lee Jones 2021-05-20 19:00 ` Lee Jones 2021-05-20 19:00 ` Lee Jones 2021-05-20 19:00 ` [PATCH 01/16] i2c: busses: i2c-nomadik: Fix formatting issue pertaining to 'timeout' Lee Jones 2021-05-20 19:00 ` Lee Jones 2021-05-27 0:21 ` Linus Walleij 2021-05-27 0:21 ` Linus Walleij 2021-05-27 19:28 ` Wolfram Sang 2021-05-27 19:28 ` Wolfram Sang 2021-05-28 7:58 ` Lee Jones 2021-05-28 7:58 ` Lee Jones 2021-05-28 8:00 ` Wolfram Sang 2021-05-28 8:00 ` Wolfram Sang 2021-05-28 8:17 ` Lee Jones 2021-05-28 8:17 ` Lee Jones 2021-05-20 19:00 ` [PATCH 02/16] i2c: muxes: i2c-arb-gpio-challenge: Demote non-conformant kernel-doc headers Lee Jones 2021-05-20 19:33 ` Doug Anderson 2021-05-21 6:32 ` Peter Rosin 2021-05-27 19:30 ` Wolfram Sang 2021-05-20 19:00 ` [PATCH 03/16] i2c: busses: i2c-ali1563: File headers are not good candidates for kernel-doc Lee Jones 2021-05-21 10:06 ` Jean Delvare 2021-05-27 19:30 ` Wolfram Sang 2021-05-20 19:00 ` [PATCH 04/16] i2c: busses: i2c-altera: Fix formatting issue in struct and demote unworthy kernel-doc headers Lee Jones 2021-06-03 20:25 ` Wolfram Sang 2021-05-20 19:00 ` [PATCH 05/16] i2c: busses: i2c-axxia: " Lee Jones 2021-06-03 20:27 ` Wolfram Sang 2021-06-04 8:49 ` Lee Jones 2021-05-20 19:00 ` [PATCH 06/16] i2c: busses: i2c-cadence: Fix incorrectly documented 'enum cdns_i2c_slave_mode' Lee Jones 2021-05-20 19:00 ` Lee Jones 2021-05-24 6:49 ` Michal Simek 2021-05-24 6:49 ` Michal Simek 2021-05-20 19:00 ` [PATCH 07/16] i2c: busses: i2c-designware-master: Fix misnaming of 'i2c_dw_init_master()' Lee Jones 2021-05-21 7:03 ` Jarkko Nikula 2021-05-20 19:00 ` [PATCH 08/16] i2c: busses: i2c-eg20t: Fix 'bad line' issue and provide description for 'msgs' param Lee Jones 2021-05-27 19:33 ` Wolfram Sang 2021-05-20 19:00 ` [PATCH 09/16] i2c: busses: i2c-mxs: Demote barely half complete kernel-doc header Lee Jones 2021-05-20 19:00 ` Lee Jones 2021-06-03 20:29 ` Wolfram Sang 2021-06-03 20:29 ` Wolfram Sang 2021-06-04 8:47 ` Lee Jones 2021-06-04 8:47 ` Lee Jones 2021-06-04 9:06 ` Wolfram Sang 2021-06-04 9:06 ` Wolfram Sang 2021-06-04 9:32 ` Lee Jones 2021-06-04 9:32 ` Lee Jones 2021-05-20 19:00 ` Lee Jones [this message] 2021-05-20 19:00 ` [PATCH 10/16] i2c: busses: i2c-ocores: Place the expected function names into the documentation headers Lee Jones 2021-05-20 19:12 ` Andrew Lunn 2021-05-20 19:12 ` Andrew Lunn 2021-05-20 20:21 ` Peter Korsgaard 2021-05-20 20:21 ` Peter Korsgaard 2021-05-27 19:33 ` Wolfram Sang 2021-05-27 19:33 ` Wolfram Sang 2021-05-20 19:01 ` [PATCH 11/16] i2c: busses: i2c-pnx: Provide descriptions for 'alg_data' data structure Lee Jones 2021-05-20 19:01 ` Lee Jones 2021-05-21 6:24 ` Vladimir Zapolskiy 2021-05-21 6:24 ` Vladimir Zapolskiy 2021-05-20 19:01 ` [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete ones Lee Jones 2021-05-20 19:01 ` Lee Jones 2021-05-20 19:01 ` Lee Jones 2021-05-20 21:52 ` Heiko Stübner 2021-05-20 21:52 ` Heiko Stübner 2021-05-20 21:52 ` Heiko Stübner 2021-05-21 6:56 ` Lee Jones 2021-05-21 6:56 ` Lee Jones 2021-05-21 6:56 ` Lee Jones 2021-06-19 22:07 ` Heiko Stuebner 2021-06-19 22:07 ` Heiko Stuebner 2021-06-19 22:07 ` Heiko Stuebner 2021-05-20 19:01 ` [PATCH 13/16] i2c: busses: i2c-st: Fix copy/paste function misnaming issues Lee Jones 2021-05-20 19:01 ` Lee Jones 2021-05-21 14:17 ` Alain Volmat 2021-05-21 14:17 ` Alain Volmat 2021-05-21 14:23 ` Alain Volmat 2021-05-21 14:23 ` Alain Volmat 2021-05-27 19:35 ` Wolfram Sang 2021-05-27 19:35 ` Wolfram Sang 2021-05-20 19:01 ` [PATCH 14/16] i2c: busses: i2c-stm32f4: Remove incorrectly placed ' ' from function name Lee Jones 2021-05-20 19:01 ` Lee Jones 2021-05-21 14:20 ` Alain Volmat 2021-05-21 14:20 ` Alain Volmat 2021-05-27 19:35 ` Wolfram Sang 2021-05-27 19:35 ` Wolfram Sang 2021-05-20 19:01 ` [PATCH 15/16] i2c: busses: i2c-tegra-bpmp: Demote kernel-doc abuses Lee Jones 2021-06-01 15:04 ` Thierry Reding 2021-05-20 19:01 ` [PATCH 16/16] i2c: busses: i2c-st: trivial: Fix spelling issue 'enmpty => empty' Lee Jones 2021-05-20 19:01 ` Lee Jones 2021-05-21 14:23 ` Alain Volmat 2021-05-21 14:23 ` Alain Volmat 2021-05-27 19:38 ` Wolfram Sang 2021-05-27 19:38 ` Wolfram Sang
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20210520190105.3772683-11-lee.jones@linaro.org \ --to=lee.jones@linaro.org \ --cc=andreas@gaisler.com \ --cc=andrew@lunn.ch \ --cc=linux-i2c@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-riscv@lists.infradead.org \ --cc=palmer@dabbelt.com \ --cc=paul.walmsley@sifive.com \ --cc=peter@korsgaard.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.