Browse Source

docs/sysfs: show() methods should use scnprintf().

Since snprintf() may return a value that exceeds its second argument,
show() methods should use scnprintf() instead of snprintf(). This patch
updates the example in the sysfs documentation accordingly.

Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Cc: Tejun Heo <tj@kernel.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Bart Van Assche 14 years ago
parent
commit
d3f70befd9
1 changed files with 3 additions and 3 deletions
  1. 3 3
      Documentation/filesystems/sysfs.txt

+ 3 - 3
Documentation/filesystems/sysfs.txt

@@ -210,9 +210,9 @@ Other notes:
   is 4096. 
   is 4096. 
 
 
 - show() methods should return the number of bytes printed into the
 - show() methods should return the number of bytes printed into the
-  buffer. This is the return value of snprintf().
+  buffer. This is the return value of scnprintf().
 
 
-- show() should always use snprintf(). 
+- show() should always use scnprintf().
 
 
 - store() should return the number of bytes used from the buffer. If the
 - store() should return the number of bytes used from the buffer. If the
   entire buffer has been used, just return the count argument.
   entire buffer has been used, just return the count argument.
@@ -231,7 +231,7 @@ A very simple (and naive) implementation of a device attribute is:
 static ssize_t show_name(struct device *dev, struct device_attribute *attr,
 static ssize_t show_name(struct device *dev, struct device_attribute *attr,
                          char *buf)
                          char *buf)
 {
 {
-	return snprintf(buf, PAGE_SIZE, "%s\n", dev->name);
+	return scnprintf(buf, PAGE_SIZE, "%s\n", dev->name);
 }
 }
 
 
 static ssize_t store_name(struct device *dev, struct device_attribute *attr,
 static ssize_t store_name(struct device *dev, struct device_attribute *attr,