From: Randy Dunlap <rdunlap@infradead.org>
To: Bart Van Assche <bvanassche@acm.org>,
"Martin K . Petersen" <martin.petersen@oracle.com>
Cc: Jaegeuk Kim <jaegeuk@kernel.org>,
linux-scsi@vger.kernel.org,
Stephen Rothwell <sfr@canb.auug.org.au>,
"James E.J. Bottomley" <jejb@linux.ibm.com>
Subject: Re: [PATCH v2 01/12] scsi: core: Suppress a kernel-doc warning
Date: Sun, 12 Dec 2021 19:06:37 -0800 [thread overview]
Message-ID: <64c22c93-a376-f6bc-c2b3-419912834605@infradead.org> (raw)
In-Reply-To: <1ad52cc7-f736-6e75-36e0-414ac32f70b4@acm.org>
On 12/12/21 19:03, Bart Van Assche wrote:
> On 12/12/21 18:53, Randy Dunlap wrote:
>> On 11/29/21 11:45, Bart Van Assche wrote:
>>> -/**
>>> +/*
>>> * scsi_enable_async_suspend - Enable async suspend and resume
>>> */
>>> void scsi_enable_async_suspend(struct device *dev)
>>>
>>
>> Why this instead of describing @dev: ?
>>
>> * @dev: the struct device to enable for async suspend and resume
>
> Hi Randy,
>
> I expect that anyone can guess the meaning of the @dev argument without adding any explanation. Hence the choice to convert the kernel-doc comment into a regular comment.
That's probably true, but we do try to document (using kernel-doc)
non-static functions for other people's use.
Oh well. Thanks.
--
~Randy
next prev parent reply other threads:[~2021-12-13 3:06 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-29 19:45 [PATCH v2 00/12] A series of small SCSI patches Bart Van Assche
2021-11-29 19:45 ` [PATCH v2 01/12] scsi: core: Suppress a kernel-doc warning Bart Van Assche
2021-12-13 2:53 ` Randy Dunlap
2021-12-13 3:03 ` Bart Van Assche
2021-12-13 3:06 ` Randy Dunlap [this message]
2021-11-29 19:45 ` [PATCH v2 02/12] scsi: core: Declare 'scsi_scan_type' static Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 03/12] scsi: core: Show SCMD_LAST in text form Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 04/12] scsi: a100u2w: Fix a kernel-doc warning Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 05/12] scsi: atp870u: " Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 06/12] scsi: bfa: Declare 'bfad_im_vport_attrs' static Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 07/12] scsi: dc395x: Fix a kernel-doc warning Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 08/12] scsi: initio: " Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 09/12] scsi: megaraid: " Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 10/12] scsi: pm8001: Fix kernel-doc warnings Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 11/12] scsi: pmcraid: Fix a kernel-doc warning Bart Van Assche
2021-11-29 19:46 ` [PATCH v2 12/12] scsi: Remove superfluous #include <linux/async.h> directives Bart Van Assche
2021-11-30 4:02 ` [PATCH v2 00/12] A series of small SCSI patches Martin K. Petersen
2021-12-03 3:03 ` Martin K. Petersen
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=64c22c93-a376-f6bc-c2b3-419912834605@infradead.org \
--to=rdunlap@infradead.org \
--cc=bvanassche@acm.org \
--cc=jaegeuk@kernel.org \
--cc=jejb@linux.ibm.com \
--cc=linux-scsi@vger.kernel.org \
--cc=martin.petersen@oracle.com \
--cc=sfr@canb.auug.org.au \
/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;
as well as URLs for NNTP newsgroup(s).