vfs: document FMODE_ constants
PATCH 8/11 vfs: document FMODE_ constants
From: Christoph Hellwig <[email protected]>
Ensure that all FMODE_ constants are documented, and ensure a coherent style for the already existing comments.
Signed-off-by Christoph Hellwig <[email protected]>
Signed-off-by Andrew Morton <[email protected]>
---
include/linux/fs.h | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-)
include/linux/fs.h renamed from include/linux/fs.h~vfs-document-fmode_-constants +17 -15
@@ -54,21 +54,23 @@ struct inodes_stat_t {#define MAY_ACCESS 16#define MAY_OPEN 32 -#define FMODE_READ ((__force fmode_t)1) -#define FMODE_WRITE ((__force fmode_t)2) - -/* Internal kernel extensions */ -#define FMODE_LSEEK ((__force fmode_t)4) -#define FMODE_PREAD ((__force fmode_t)8) -#define FMODE_PWRITE FMODE_PREAD/* These go hand in hand */ - -/* File is being opened for execution. Primary users of this flag are -distributed filesystems that can use it to achieve correct ETXTBUSY -behavior for cross-node execution/opening_for_writing of files */ -#define FMODE_EXEC ((__force fmode_t)16) - -#define FMODE_NDELAY ((__force fmode_t)32) -#define FMODE_EXCL ((__force fmode_t)64) +/* file is open for reading */ +#define FMODE_READ ((__force fmode_t)1) +/* file is open for writing */ +#define FMODE_WRITE ((__force fmode_t)2) +/* file is seekable */ +#define FMODE_LSEEK ((__force fmode_t)4) +/* file can be accessed using pread/pwrite */ +#define FMODE_PREAD ((__force fmode_t)8) +#define FMODE_PWRITE FMODE_PREAD/* These go hand in hand */ +/* File is opened for execution with sys_execve / sys_uselib */ +#define FMODE_EXEC ((__force fmode_t)16) +/* File is opened with O_NDELAY (only set for block devices) */ +#define FMODE_NDELAY ((__force fmode_t)32) +/* File is opened with O_EXCL (only set for block devices) */ +#define FMODE_EXCL ((__force fmode_t)64) +/* File is opened using open(.., 3, ..) and is writeable only for ioctls +(specialy hack for floppy.c) */ #define FMODE_WRITE_IOCTL ((__force fmode_t)128)#define RW_MASK 1
_