All of lore.kernel.org
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>,
	linux-kernel@vger.kernel.org
Cc: Evgeniy Polyakov <zbr@ioremap.net>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Arnd Bergmann <arnd@arndb.de>, Olof Johansson <olof@lixom.net>,
	soc@kernel.org, linux-arm-kernel@lists.infradead.org
Subject: [PATCH 02/15] w1: ds2433: correct kerneldoc annotation
Date: Sat, 15 Apr 2023 12:42:50 +0200	[thread overview]
Message-ID: <20230415104304.104134-2-krzysztof.kozlowski@linaro.org> (raw)
In-Reply-To: <20230415104304.104134-1-krzysztof.kozlowski@linaro.org>

Correct kerneldoc comments (or drop annotation) to fix:

  w1_ds2433.c:46: warning: This comment starts with '/**', but isn't a kernel-doc comment.
  w1_ds2433.c:141: warning: This comment starts with '/**', but isn't a kernel-doc comment.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
---
 drivers/w1/slaves/w1_ds2433.c | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/drivers/w1/slaves/w1_ds2433.c b/drivers/w1/slaves/w1_ds2433.c
index 0f72df15a024..6134ca2f37fe 100644
--- a/drivers/w1/slaves/w1_ds2433.c
+++ b/drivers/w1/slaves/w1_ds2433.c
@@ -42,7 +42,7 @@ struct w1_f23_data {
 	u32	validcrc;
 };
 
-/**
+/*
  * Check the file size bounds and adjusts count as needed.
  * This would not be needed if the file size didn't reset to 0 after a write.
  */
@@ -138,16 +138,17 @@ static ssize_t eeprom_read(struct file *filp, struct kobject *kobj,
 }
 
 /**
- * Writes to the scratchpad and reads it back for verification.
+ * w1_f23_write() - Writes to the scratchpad and reads it back for verification.
+ * @sl:		The slave structure
+ * @addr:	Address for the write
+ * @len:	length must be <= (W1_PAGE_SIZE - (addr & W1_PAGE_MASK))
+ * @data:	The data to write
+ *
  * Then copies the scratchpad to EEPROM.
  * The data must be on one page.
  * The master must be locked.
  *
- * @param sl	The slave structure
- * @param addr	Address for the write
- * @param len   length must be <= (W1_PAGE_SIZE - (addr & W1_PAGE_MASK))
- * @param data	The data to write
- * @return	0=Success -1=failure
+ * Return:	0=Success, -1=failure
  */
 static int w1_f23_write(struct w1_slave *sl, int addr, int len, const u8 *data)
 {
-- 
2.34.1


WARNING: multiple messages have this Message-ID (diff)
From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>,
	linux-kernel@vger.kernel.org
Cc: Evgeniy Polyakov <zbr@ioremap.net>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Arnd Bergmann <arnd@arndb.de>, Olof Johansson <olof@lixom.net>,
	soc@kernel.org, linux-arm-kernel@lists.infradead.org
Subject: [PATCH 02/15] w1: ds2433: correct kerneldoc annotation
Date: Sat, 15 Apr 2023 12:42:50 +0200	[thread overview]
Message-ID: <20230415104304.104134-2-krzysztof.kozlowski@linaro.org> (raw)
In-Reply-To: <20230415104304.104134-1-krzysztof.kozlowski@linaro.org>

Correct kerneldoc comments (or drop annotation) to fix:

  w1_ds2433.c:46: warning: This comment starts with '/**', but isn't a kernel-doc comment.
  w1_ds2433.c:141: warning: This comment starts with '/**', but isn't a kernel-doc comment.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
---
 drivers/w1/slaves/w1_ds2433.c | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/drivers/w1/slaves/w1_ds2433.c b/drivers/w1/slaves/w1_ds2433.c
index 0f72df15a024..6134ca2f37fe 100644
--- a/drivers/w1/slaves/w1_ds2433.c
+++ b/drivers/w1/slaves/w1_ds2433.c
@@ -42,7 +42,7 @@ struct w1_f23_data {
 	u32	validcrc;
 };
 
-/**
+/*
  * Check the file size bounds and adjusts count as needed.
  * This would not be needed if the file size didn't reset to 0 after a write.
  */
@@ -138,16 +138,17 @@ static ssize_t eeprom_read(struct file *filp, struct kobject *kobj,
 }
 
 /**
- * Writes to the scratchpad and reads it back for verification.
+ * w1_f23_write() - Writes to the scratchpad and reads it back for verification.
+ * @sl:		The slave structure
+ * @addr:	Address for the write
+ * @len:	length must be <= (W1_PAGE_SIZE - (addr & W1_PAGE_MASK))
+ * @data:	The data to write
+ *
  * Then copies the scratchpad to EEPROM.
  * The data must be on one page.
  * The master must be locked.
  *
- * @param sl	The slave structure
- * @param addr	Address for the write
- * @param len   length must be <= (W1_PAGE_SIZE - (addr & W1_PAGE_MASK))
- * @param data	The data to write
- * @return	0=Success -1=failure
+ * Return:	0=Success, -1=failure
  */
 static int w1_f23_write(struct w1_slave *sl, int addr, int len, const u8 *data)
 {
-- 
2.34.1


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  reply	other threads:[~2023-04-15 10:44 UTC|newest]

Thread overview: 46+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-15 10:42 [PATCH 01/15] w1: ds2408: drop kerneldoc annotation Krzysztof Kozlowski
2023-04-15 10:42 ` Krzysztof Kozlowski
2023-04-15 10:42 ` Krzysztof Kozlowski [this message]
2023-04-15 10:42   ` [PATCH 02/15] w1: ds2433: correct " Krzysztof Kozlowski
2023-04-15 16:08   ` Randy Dunlap
2023-04-15 16:08     ` Randy Dunlap
2023-04-15 10:42 ` [PATCH 03/15] w1: ds28e04: " Krzysztof Kozlowski
2023-04-15 10:42   ` Krzysztof Kozlowski
2023-04-15 16:07   ` Randy Dunlap
2023-04-15 16:07     ` Randy Dunlap
2023-04-15 10:42 ` [PATCH 04/15] w1: minor white-space and code style fixes Krzysztof Kozlowski
2023-04-15 10:42   ` Krzysztof Kozlowski
2023-04-15 10:42 ` [PATCH 4/4] w1: omap-hdq: allow compile testing Krzysztof Kozlowski
2023-04-15 10:42   ` Krzysztof Kozlowski
2023-04-15 15:18   ` Greg Kroah-Hartman
2023-04-15 15:18     ` Greg Kroah-Hartman
2023-04-16  7:18     ` Krzysztof Kozlowski
2023-04-16  7:18       ` Krzysztof Kozlowski
2023-04-15 10:42 ` [PATCH 05/15] w1: use octal for file permissions Krzysztof Kozlowski
2023-04-15 10:42   ` Krzysztof Kozlowski
2023-04-15 10:42 ` [PATCH 06/15] w1: ds2433: do not use assignment in if condition Krzysztof Kozlowski
2023-04-15 10:42   ` Krzysztof Kozlowski
2023-04-15 10:42 ` [PATCH 07/15] w1: ds2482: drop unnecessary header Krzysztof Kozlowski
2023-04-15 10:42   ` Krzysztof Kozlowski
2023-04-15 10:42 ` [PATCH 08/15] w1: ds2482: do not use assignment in if condition Krzysztof Kozlowski
2023-04-15 10:42   ` Krzysztof Kozlowski
2023-04-15 10:42 ` [PATCH 09/15] w1: matrox: switch from asm to linux header Krzysztof Kozlowski
2023-04-15 10:42   ` Krzysztof Kozlowski
2023-04-15 10:42 ` [PATCH 10/15] w1: matrox: use inline over __inline__ Krzysztof Kozlowski
2023-04-15 10:42   ` Krzysztof Kozlowski
2023-04-15 10:43 ` [PATCH 11/15] w1: matrox: remove unnecessary ENOMEM messages Krzysztof Kozlowski
2023-04-15 10:43   ` Krzysztof Kozlowski
2023-04-15 10:43 ` [PATCH 12/15] w1: omap-hdq: allow compile testing Krzysztof Kozlowski
2023-04-15 10:43   ` Krzysztof Kozlowski
2023-04-15 16:05   ` Randy Dunlap
2023-04-15 16:05     ` Randy Dunlap
2023-04-16  7:22     ` Krzysztof Kozlowski
2023-04-16  7:22       ` Krzysztof Kozlowski
2023-04-15 10:43 ` [PATCH 13/15] w1: omap-hdq: add SPDX tag Krzysztof Kozlowski
2023-04-15 10:43   ` Krzysztof Kozlowski
2023-04-15 10:43 ` [PATCH 14/15] w1: omap-hdq: remove unnecessary ENOMEM messages Krzysztof Kozlowski
2023-04-15 10:43   ` Krzysztof Kozlowski
2023-04-15 10:43 ` [PATCH 15/15] w1: gpio: " Krzysztof Kozlowski
2023-04-15 10:43   ` Krzysztof Kozlowski
2023-04-15 16:07 ` [PATCH 01/15] w1: ds2408: drop kerneldoc annotation Randy Dunlap
2023-04-15 16:07   ` Randy Dunlap

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=20230415104304.104134-2-krzysztof.kozlowski@linaro.org \
    --to=krzysztof.kozlowski@linaro.org \
    --cc=arnd@arndb.de \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=olof@lixom.net \
    --cc=soc@kernel.org \
    --cc=zbr@ioremap.net \
    /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: link
Be 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.