Skip to contentSkip to conversation

staging: greybus: audio: add missing newline to sysfs_emit formats

PATCH In review Brock Haftner 2 participants 4 messages Jun 13

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 staging: greybus: audio: add missing newline to sysfs_emit formats

The sysfs_emit() function is used to format strings that are returned to userspace. According to the sysfs documentation, these outputs should include a newline character for visual clarity.

Fix the checkpatch.pl warnings by adding the missing '\n' to the sysfs_emit() format strings inside several functions.

---
 drivers/staging/greybus/audio_manager_module.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
drivers/staging/greybus/audio_manager_module.c +6 -6
index dc90cc2d2308..5737f2a32f5a 100644
@@ -75,7 +75,7 @@ static void gb_audio_module_release(struct kobject *kobj)
 static ssize_t gb_audio_module_name_show(struct gb_audio_manager_module *module,
 					 struct gb_audio_manager_module_attribute *attr, char *buf)
 {
-	return sysfs_emit(buf, "%s", module->desc.name);
+	return sysfs_emit(buf, "%s\n", module->desc.name);
 }
 
 static struct gb_audio_manager_module_attribute gb_audio_module_name_attribute =
@@ -84,7 +84,7 @@ static struct gb_audio_manager_module_attribute gb_audio_module_name_attribute =
 static ssize_t gb_audio_module_vid_show(struct gb_audio_manager_module *module,
 					struct gb_audio_manager_module_attribute *attr, char *buf)
 {
-	return sysfs_emit(buf, "%d", module->desc.vid);
+	return sysfs_emit(buf, "%d\n", module->desc.vid);
 }
 
 static struct gb_audio_manager_module_attribute gb_audio_module_vid_attribute =
@@ -93,7 +93,7 @@ static struct gb_audio_manager_module_attribute gb_audio_module_vid_attribute =
 static ssize_t gb_audio_module_pid_show(struct gb_audio_manager_module *module,
 					struct gb_audio_manager_module_attribute *attr, char *buf)
 {
-	return sysfs_emit(buf, "%d", module->desc.pid);
+	return sysfs_emit(buf, "%d\n", module->desc.pid);
 }
 
 static struct gb_audio_manager_module_attribute gb_audio_module_pid_attribute =
@@ -103,7 +103,7 @@ static ssize_t gb_audio_module_intf_id_show(struct gb_audio_manager_module *modu
 					    struct gb_audio_manager_module_attribute *attr,
 					    char *buf)
 {
-	return sysfs_emit(buf, "%d", module->desc.intf_id);
+	return sysfs_emit(buf, "%d\n", module->desc.intf_id);
 }
 
 static struct gb_audio_manager_module_attribute
@@ -114,7 +114,7 @@ static ssize_t gb_audio_module_ip_devices_show(struct gb_audio_manager_module *m
 					       struct gb_audio_manager_module_attribute *attr,
 					       char *buf)
 {
-	return sysfs_emit(buf, "0x%X", module->desc.ip_devices);
+	return sysfs_emit(buf, "0x%X\n", module->desc.ip_devices);
 }
 
 static struct gb_audio_manager_module_attribute
@@ -125,7 +125,7 @@ static ssize_t gb_audio_module_op_devices_show(struct gb_audio_manager_module *m
 					       struct gb_audio_manager_module_attribute *attr,
 					       char *buf)
 {
-	return sysfs_emit(buf, "0x%X", module->desc.op_devices);
+	return sysfs_emit(buf, "0x%X\n", module->desc.op_devices);
 }
 
 static struct gb_audio_manager_module_attribute
Signature · 1 line
2.54.0
#1 lore raw
Quoted 8 lines · Brock Haftner

The sysfs_emit() function is used to format strings that are returned to userspace. According to the sysfs documentation, these outputs should include a newline character for visual clarity.

Fix the checkpatch.pl warnings by adding the missing '\n' to the sysfs_emit() format strings inside several functions.

Please don't do this for existing code, only for new code. There is a risck that user space relies on the old behavior.

regards,
dan carpenter

#2 lore raw
Quoted 5 lines · Dan Carpenter
Quoted 4 lines · Brock Haftner

The sysfs_emit() function is used to format strings that are returned to userspace. According to the sysfs documentation, these outputs should include a newline character for visual clarity.

Quoted 7 lines
Quoted 4 lines

Fix the checkpatch.pl warnings by adding the missing '\n' to the sysfs_emit() format strings inside several functions.

Please don't do this for existing code, only for new code. There is a risck that user space relies on the old behavior.

We should delete this checkpatch warning really. It could be a sashiko rule which only applies for patches which introduce new functions or something.

regards,
dan carpenter

#3 lore raw
Quoted 9 lines · Dan Carpenter
Quoted 8 lines · Dan Carpenter
Quoted 7 lines · Brock Haftner

The sysfs_emit() function is used to format strings that are returned to userspace. According to the sysfs documentation, these outputs should include a newline character for visual clarity.

Fix the checkpatch.pl warnings by adding the missing '\n' to the sysfs_emit() format strings inside several functions.

Quoted 8 lines
Quoted 4 lines
Quoted 1 line

Please don't do this for existing code, only for new code. There is a risck that user space relies on the old behavior.

We should delete this checkpatch warning really. It could be a sashiko rule which only applies for patches which introduce new functions or something.

Thank you for the explanation, apologies for the mistake. I did not consider user-space implications for adding the newline characters. I will drop this patch, thank you for the reply.

Cheers,
Brock

Quoted 22 lines · Dan Carpenter
Quoted 5 lines · Dan Carpenter
Quoted 4 lines · Brock Haftner

The sysfs_emit() function is used to format strings that are returned to userspace. According to the sysfs documentation, these outputs should include a newline character for visual clarity.

Quoted 7 lines
Quoted 4 lines

Fix the checkpatch.pl warnings by adding the missing '\n' to the sysfs_emit() format strings inside several functions.

Please don't do this for existing code, only for new code. There is a risck that user space relies on the old behavior.

We should delete this checkpatch warning really. It could be a sashiko rule which only applies for patches which introduce new functions or something.

regards,
dan carpenter