diff mbox series

[v2,2/5] scsi: core: Update a source code comment

Message ID 20230503230654.2441121-3-bvanassche@acm.org
State New
Headers show
Series SCSI core patches | expand

Commit Message

Bart Van Assche May 3, 2023, 11:06 p.m. UTC
The proc_name SCSI host template attribute is used for:
- The name of the /proc directory if CONFIG_SCSI_PROC_FS=y.
- The contents of the proc_name SCSI host sysfs attribute.

The current comment in include/scsi/scsi_host.h is not correct if
CONFIG_SCSI_PROC_FS=n. Hence, change that comment.

Cc: Christoph Hellwig <hch@lst.de>
Cc: Ming Lei <ming.lei@redhat.com>
Cc: Hannes Reinecke <hare@suse.de>
Cc: John Garry <john.g.garry@oracle.com>
Cc: Mike Christie <michael.christie@oracle.com>
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 include/scsi/scsi_host.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Christoph Hellwig May 5, 2023, 6 a.m. UTC | #1
Looks good:

Reviewed-by: Christoph Hellwig <hch@lst.de>
Bart Van Assche May 8, 2023, 2:09 p.m. UTC | #2
On 5/8/23 04:25, Benjamin Block wrote:
> On Wed, May 03, 2023 at 04:06:51PM -0700, Bart Van Assche wrote:
>> The proc_name SCSI host template attribute is used for:
>> - The name of the /proc directory if CONFIG_SCSI_PROC_FS=y.
> 
> But now you remove that case completely? It seems kinda strange to
> bother touching the comment, but then only switching from one incomplete
> form to an other?

Using procfs as an interface to other information than process information
is deprecated, so I'm not sure it's worth mentioning how this name is used
if CONFIG_SCSI_PROC_FS=y.

Bart.
diff mbox series

Patch

diff --git a/include/scsi/scsi_host.h b/include/scsi/scsi_host.h
index 0f29799efa02..18632adca17e 100644
--- a/include/scsi/scsi_host.h
+++ b/include/scsi/scsi_host.h
@@ -365,7 +365,7 @@  struct scsi_host_template {
 
 
 	/*
-	 * Name of proc directory
+	 * Name reported via the proc_name SCSI host sysfs attribute.
 	 */
 	const char *proc_name;