Re: [PATCH v2 2/2] fs: add missing documentation to simple_xattr functions

Randy Dunlap
2012-09-13T18:02:50Z

On 09/11/2012 01:28 PM, Aristeu Rozanski wrote:

+/**
+ * simple_xattr_set: xattr SET operation for in-memory/pseudo filesystems

The format for the function name/description uses '-', not ':', as:

* simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems

+ * @xattrs: simple_xattr list
+ * @name: name of the new extended attribute
+ * @value: value of the new extended attribute. If NULL, will remove the
+ * attribute

Missing @size parameter description.

+ * @flags: if XATTR_CREATE is set, no already existing extended attribute may
+ * exist. If XATTR_REPLACE is set, the extended attribute should exist.
+ *
+ * returns -ENOMEM for allocation failures, -EEXIST in case XATTR_CREATE is
+ * set in flags and an extended attribute with the same name exists,
+ * -ENODATA if XATTR_REPLACE is set in flags but no entry with the
+ * specified name exists.
*/
int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
const void *value, size_t size, int flags)

--
~Randy