linux-kernel - Re: [PATCH v4 2/4] HID: hid-sensor-custom: Convert sprintf() family to sysfs

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>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Mon, 25 Mar 2024 09:50:05 +0000
From: "Zhijian Li (Fujitsu)" <lizhijian@...itsu.com>
To: Jonathan Cameron <jic23@...nel.org>
CC: "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>, Jiri Kosina
	<jikos@...nel.org>, Srinivas Pandruvada
	<srinivas.pandruvada@...ux.intel.com>, Benjamin Tissoires
	<benjamin.tissoires@...hat.com>, "linux-input@...r.kernel.org"
	<linux-input@...r.kernel.org>, "linux-iio@...r.kernel.org"
	<linux-iio@...r.kernel.org>, Jonathan Cameron <Jonathan.Cameron@...wei.com>
Subject: Re: [PATCH v4 2/4] HID: hid-sensor-custom: Convert sprintf() family
 to sysfs_emit() family



On 24/03/2024 20:16, Jonathan Cameron wrote:
> On Tue, 19 Mar 2024 13:45:25 +0800
> Li Zhijian <lizhijian@...itsu.com> wrote:
> 
>> Per filesystems/sysfs.rst, show() should only use sysfs_emit()
>> or sysfs_emit_at() when formatting the value to be returned to user space.
>>
>> coccinelle complains that there are still a couple of functions that use
>> snprintf(). Convert them to sysfs_emit().
>>
>> sprintf() and scnprintf() will be converted as well if they have.
>>
>> Generally, this patch is generated by
>> make coccicheck M=<path/to/file> MODE=patch \
>> COCCI=scripts/coccinelle/api/device_attr_show.cocci
>>
>> No functional change intended
>>
>> CC: Jiri Kosina <jikos@...nel.org>
>> CC: Jonathan Cameron <jic23@...nel.org>
>> CC: Srinivas Pandruvada <srinivas.pandruvada@...ux.intel.com>
>> CC: Benjamin Tissoires <benjamin.tissoires@...hat.com>
>> CC: linux-input@...r.kernel.org
>> CC: linux-iio@...r.kernel.org
> 
> As a general rule, don't have cc's of lists up here. It makes
> a mess of the logs. Also once you have another tag drop CC of
> same person (even if it's a different email address).
> 

Thank you Jonathan.

Understood!

> We don't want to fill the git log with useless information.
> 
> I think git is fine picking up CC's from below the --- so you
> can add them there if it simplifies how you send your patch
> sets out.

Great, it sounds good to me.


Thanks
Zhijian


> 
> 
>> Reviewed-by: Jonathan Cameron <Jonathan.Cameron@...wei.com>
>> Signed-off-by: Li Zhijian <lizhijian@...itsu.com>
>> ---
>> V3:
>>     rewrap the line as will be under 80 chars and add Reviewed-by # Jonathan
>> This is a part of the work "Fix coccicheck device_attr_show warnings"[1]
>> Split them per subsystem so that the maintainer can review it easily
>> [1] https://lore.kernel.org/lkml/20240116041129.3937800-1-lizhijian@fujitsu.com/
>> ---
>>   drivers/hid/hid-sensor-custom.c | 9 ++++-----
>>   1 file changed, 4 insertions(+), 5 deletions(-)
>>
>> diff --git a/drivers/hid/hid-sensor-custom.c b/drivers/hid/hid-sensor-custom.c
>> index d85398721659..ac214777d7d9 100644
>> --- a/drivers/hid/hid-sensor-custom.c
>> +++ b/drivers/hid/hid-sensor-custom.c
>> @@ -155,7 +155,7 @@ static ssize_t enable_sensor_show(struct device *dev,
>>   {
>>   	struct hid_sensor_custom *sensor_inst = dev_get_drvdata(dev);
>>   
>> -	return sprintf(buf, "%d\n", sensor_inst->enable);
>> +	return sysfs_emit(buf, "%d\n", sensor_inst->enable);
>>   }
>>   
>>   static int set_power_report_state(struct hid_sensor_custom *sensor_inst,
>> @@ -372,14 +372,13 @@ static ssize_t show_value(struct device *dev, struct device_attribute *attr,
>>   				     sizeof(struct hid_custom_usage_desc),
>>   				     usage_id_cmp);
>>   		if (usage_desc)
>> -			return snprintf(buf, PAGE_SIZE, "%s\n",
>> -					usage_desc->desc);
>> +			return sysfs_emit(buf, "%s\n", usage_desc->desc);
>>   		else
>> -			return sprintf(buf, "not-specified\n");
>> +			return sysfs_emit(buf, "not-specified\n");
>>   	 } else
>>   		return -EINVAL;
>>   
>> -	return sprintf(buf, "%d\n", value);
>> +	return sysfs_emit(buf, "%d\n", value);
>>   }
>>   
>>   static ssize_t store_value(struct device *dev, struct device_attribute *attr,
>