From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Damien Le Moal <dlemoal@kernel.org>,
Niklas Cassel <cassel@kernel.org>,
linux-ide@vger.kernel.org
Subject: [PATCH] ata: libata: avoid kernel-doc warnings
Date: Fri, 24 Jul 2026 18:52:09 -0700 [thread overview]
Message-ID: <20260725015209.1207666-1-rdunlap@infradead.org> (raw)
Modify comments to prevent kernel-doc warnings:
- use "/*" for a non-kernel-doc comment
- add a Returns: section for ata_id_major_version()
Warning: include/linux/ata.h:770 Cannot find identifier on line:
*
Warning: include/linux/ata.h:782 function parameter 'id' not described in 'ata_id_sct_data_tables'
Warning: include/linux/ata.h:782 expecting prototype for Word(). Prototype was for ata_id_sct_data_tables() instead
Warning: include/linux/ata.h:820 No description found for return value of 'ata_id_major_version'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Damien Le Moal <dlemoal@kernel.org>
Cc: Niklas Cassel <cassel@kernel.org>
Cc: linux-ide@vger.kernel.org
include/linux/ata.h | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
--- linux-next-20260722.orig/include/linux/ata.h
+++ linux-next-20260722/include/linux/ata.h
@@ -767,8 +767,7 @@ static inline bool ata_id_sense_reportin
return id[ATA_ID_COMMAND_SET_4] & BIT(6);
}
-/**
- *
+/*
* Word: 206 - SCT Command Transport
* 15:12 - Vendor Specific
* 11:6 - Reserved
@@ -815,6 +814,8 @@ static inline bool ata_id_sct_supported(
*
* The practical impact of this is that ata_id_major_version cannot
* reliably report on drives below ATA3.
+ *
+ * Returns: major version of ATA drive level or %0 if unknown
*/
static inline unsigned int ata_id_major_version(const u16 *id)
next reply other threads:[~2026-07-25 1:52 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-25 1:52 Randy Dunlap [this message]
2026-07-26 2:49 ` Damien Le Moal
2026-07-26 3:41 ` Randy Dunlap
2026-07-26 4:14 ` Damien Le Moal
2026-07-26 4:19 ` Randy Dunlap
2026-07-27 2:02 ` Damien Le Moal
2026-07-27 1:49 ` Damien Le Moal
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=20260725015209.1207666-1-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=cassel@kernel.org \
--cc=dlemoal@kernel.org \
--cc=linux-ide@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®