Changeset 61097 in vbox for trunk/include/iprt/linux

Timestamp:

May 20, 2016 1:24:27 PM (9 years ago)

Author:

vboxsync

Message:

sysfs.h: spec clearification.

File:

• trunk/include/iprt/linux/sysfs.h (modified) (2 diffs)

trunk/include/iprt/linux/sysfs.h

@@ -132 +132 @@
  * Reads a string from a file opened with RTLinuxSysFsOpen or RTLinuxSysFsOpenV.
  *
+ * Expects to read the whole file, mind, and will return VERR_BUFFER_OVERFLOW if
+ * that is not possible with the given buffer size.
+ *
  * @returns IPRT status code.
  * @param   hFile       The file descriptor returned by RTLinuxSysFsOpen or RTLinuxSysFsOpenV.
@@ -315 +318 @@
 
 /**
- * Reads a string from a sysfs file.  If the file contains a newline, we only
- * return the text up until there.
+ * Reads a string from a sysfs file.
+ *
+ * If the file contains a newline, we only return the text up until there.  This
+ * differs from the RTLinuxSysFsReadStr() behaviour.
  *
  * @returns IPRT status code.