diff mbox series

[v2] scsi: scsi_transport_sas: add missing newline when printing 'enable' by sysfs

Message ID 1594975472-12486-1-git-send-email-wangxiongfeng2@huawei.com (mailing list archive)
State Mainlined
Commit ede74559ed8b1e1d1ac5611db1057ab0ec5b213b
Headers show
Series [v2] scsi: scsi_transport_sas: add missing newline when printing 'enable' by sysfs | expand

Commit Message

Xiongfeng Wang July 17, 2020, 8:44 a.m. UTC 
When I cat sysfs file 'enable' below 'sas_phy', it displays as follows.
It's better to add a newline for easy reading.

[root@localhost ~]# cat /sys/devices/pci0000:00/0000:00:0d.0/0000:0f:00.0/host3/phy-3:2/sas_phy/phy-3:2/enable
1[root@localhost ~]#

Signed-off-by: Xiongfeng Wang <wangxiongfeng2@huawei.com>
Reviewed-by: John Garry <john.garry@huawei.com>

---
v1 -> v2:
	modify commit subject.
	add Reviewed-by tag.
---
 drivers/scsi/scsi_transport_sas.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Bart Van Assche July 18, 2020, 8:25 p.m. UTC | #1 
On 2020-07-17 01:44, Xiongfeng Wang wrote:
> diff --git a/drivers/scsi/scsi_transport_sas.c b/drivers/scsi/scsi_transport_sas.c
> index 182fd25..e443dee 100644
> --- a/drivers/scsi/scsi_transport_sas.c
> +++ b/drivers/scsi/scsi_transport_sas.c
> @@ -563,7 +563,7 @@ static ssize_t do_sas_phy_enable(struct device *dev,
>  {
>  	struct sas_phy *phy = transport_class_to_phy(dev);
>  
> -	return snprintf(buf, 20, "%d", phy->enabled);
> +	return snprintf(buf, 20, "%d\n", phy->enabled);
>  }

For future sysfs show function patches, please use PAGE_SIZE as second
snprintf() argument or use sprintf() instead of snprintf() because in
this case it is clear that no output buffer overflow will happen. Using
any other size argument than PAGE_SIZE makes patches like the above
harder to verify than necessary. Anyway:

Reviewed-by: Bart van Assche <bvanassche@acm.org>
Xiongfeng Wang July 20, 2020, 2:07 a.m. UTC | #2 
Hi,

On 2020/7/19 4:25, Bart Van Assche wrote:
> On 2020-07-17 01:44, Xiongfeng Wang wrote:
>> diff --git a/drivers/scsi/scsi_transport_sas.c b/drivers/scsi/scsi_transport_sas.c
>> index 182fd25..e443dee 100644
>> --- a/drivers/scsi/scsi_transport_sas.c
>> +++ b/drivers/scsi/scsi_transport_sas.c
>> @@ -563,7 +563,7 @@ static ssize_t do_sas_phy_enable(struct device *dev,
>>  {
>>  	struct sas_phy *phy = transport_class_to_phy(dev);
>>  
>> -	return snprintf(buf, 20, "%d", phy->enabled);
>> +	return snprintf(buf, 20, "%d\n", phy->enabled);
>>  }
> 
> For future sysfs show function patches, please use PAGE_SIZE as second
> snprintf() argument or use sprintf() instead of snprintf() because in
> this case it is clear that no output buffer overflow will happen. Using

Thanks for your advice. I will follow it in the future patches.

> any other size argument than PAGE_SIZE makes patches like the above
> harder to verify than necessary. Anyway:
> 
> Reviewed-by: Bart van Assche <bvanassche@acm.org>

Thanks,
Xiongfeng

>
Martin K. Petersen July 21, 2020, 3:42 a.m. UTC | #3 
On Fri, 17 Jul 2020 16:44:32 +0800, Xiongfeng Wang wrote:

> When I cat sysfs file 'enable' below 'sas_phy', it displays as follows.
> It's better to add a newline for easy reading.
> 
> [root@localhost ~]# cat /sys/devices/pci0000:00/0000:00:0d.0/0000:0f:00.0/host3/phy-3:2/sas_phy/phy-3:2/enable
> 1[root@localhost ~]#

Applied to 5.9/scsi-queue, thanks!

[1/1] scsi: scsi_transport_sas: Add missing newline in sysfs 'enable' attribute
      https://git.kernel.org/mkp/scsi/c/38364267251f
diff mbox series

Patch

diff --git a/drivers/scsi/scsi_transport_sas.c b/drivers/scsi/scsi_transport_sas.c
index 182fd25..e443dee 100644
--- a/drivers/scsi/scsi_transport_sas.c
+++ b/drivers/scsi/scsi_transport_sas.c
@@ -563,7 +563,7 @@  static ssize_t do_sas_phy_enable(struct device *dev,
 {
 	struct sas_phy *phy = transport_class_to_phy(dev);
 
-	return snprintf(buf, 20, "%d", phy->enabled);
+	return snprintf(buf, 20, "%d\n", phy->enabled);
 }
 
 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, show_sas_phy_enable,