linux-kernel - [PATCH] w1: slaves: fix W=1 kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:   Thu, 12 Jan 2023 22:41:48 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Evgeniy Polyakov <zbr@...emap.net>
Subject: [PATCH] w1: slaves: fix W=1 kernel-doc warnings

Fix all W=1 kernel-doc warnings in drivers/w1/ by not using
"/**" to begin comments that are not in kernel-doc format.
Fixes these warnings:

drivers/w1/slaves/w1_ds2408.c:210: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Writing to the activity file resets the activity latches.
drivers/w1/slaves/w1_ds2433.c:46: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Check the file size bounds and adjusts count as needed.
drivers/w1/slaves/w1_ds2433.c:141: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Writes to the scratchpad and reads it back for verification.
drivers/w1/slaves/w1_ds28e04.c:57: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Check the file size bounds and adjusts count as needed.
drivers/w1/slaves/w1_ds28e04.c:149: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Writes to the scratchpad and reads it back for verification.

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Evgeniy Polyakov <zbr@...emap.net>
---
 drivers/w1/slaves/w1_ds2408.c  |    2 +-
 drivers/w1/slaves/w1_ds2433.c  |    4 ++--
 drivers/w1/slaves/w1_ds28e04.c |    4 ++--
 3 files changed, 5 insertions(+), 5 deletions(-)

diff -- a/drivers/w1/slaves/w1_ds2408.c b/drivers/w1/slaves/w1_ds2408.c
--- a/drivers/w1/slaves/w1_ds2408.c
+++ b/drivers/w1/slaves/w1_ds2408.c
@@ -206,7 +206,7 @@ out:
 }

-/**
+/*
  * Writing to the activity file resets the activity latches.
  */
 static ssize_t activity_write(struct file *filp, struct kobject *kobj,
diff -- a/drivers/w1/slaves/w1_ds2433.c b/drivers/w1/slaves/w1_ds2433.c
--- 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.
  */
@@ -137,7 +137,7 @@ out_up:
 	return count;
 }

-/**
+/*
  * Writes to the scratchpad and reads it back for verification.
  * Then copies the scratchpad to EEPROM.
  * The data must be on one page.
diff -- a/drivers/w1/slaves/w1_ds28e04.c b/drivers/w1/slaves/w1_ds28e04.c
--- a/drivers/w1/slaves/w1_ds28e04.c
+++ b/drivers/w1/slaves/w1_ds28e04.c
@@ -53,7 +53,7 @@ struct w1_f1C_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.
  */
@@ -145,7 +145,7 @@ out_up:
 	return count;
 }

-/**
+/*
  * Writes to the scratchpad and reads it back for verification.
  * Then copies the scratchpad to EEPROM.
  * The data must be on one page.