nilfs2: correct return value kernel-doc descriptions for metadata files (b8268501) · Commits · git / linux-net

fs/nilfs2/cpfile.c

+20 −31

Original line number	Diff line number	Diff line
		@@ -191,14 +191,11 @@ static inline int nilfs_cpfile_get_checkpoint_block(struct inode *cpfile,
		* @cnop: place to store the next checkpoint number
		* @bhp: place to store a pointer to buffer_head struct
		*
		* Return Value: On success, it returns 0. On error, the following negative
		* error code is returned.
		*
		* %-ENOMEM - Insufficient memory available.
		*
		* %-EIO - I/O error
		*
		* %-ENOENT - no block exists in the range.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOENT - no block exists in the range.
		* * %-ENOMEM - Insufficient memory available.
		*/
		static int nilfs_cpfile_find_checkpoint_block(struct inode *cpfile,
		__u64 start_cno, __u64 end_cno,
		@@ -447,14 +444,11 @@ int nilfs_cpfile_finalize_checkpoint(struct inode *cpfile, __u64 cno,
		* the period from @start to @end, excluding @end itself. The checkpoints
		* which have been already deleted are ignored.
		*
		* Return Value: On success, 0 is returned. On error, one of the following
		* negative error codes is returned.
		*
		* %-EIO - I/O error.
		*
		* %-ENOMEM - Insufficient amount of memory available.
		*
		* %-EINVAL - invalid checkpoints.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EINVAL - Invalid checkpoints.
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOMEM - Insufficient memory available.
		*/
		int nilfs_cpfile_delete_checkpoints(struct inode *cpfile,
		__u64 start,
		@@ -1058,14 +1052,11 @@ int nilfs_cpfile_is_snapshot(struct inode *cpfile, __u64 cno)
		* Description: nilfs_change_cpmode() changes the mode of the checkpoint
		* specified by @cno. The mode @mode is NILFS_CHECKPOINT or NILFS_SNAPSHOT.
		*
		* Return Value: On success, 0 is returned. On error, one of the following
		* negative error codes is returned.
		*
		* %-EIO - I/O error.
		*
		* %-ENOMEM - Insufficient amount of memory available.
		*
		* %-ENOENT - No such checkpoint.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOENT - No such checkpoint.
		* * %-ENOMEM - Insufficient memory available.
		*/
		int nilfs_cpfile_change_cpmode(struct inode *cpfile, __u64 cno, int mode)
		{
		@@ -1097,14 +1088,12 @@ int nilfs_cpfile_change_cpmode(struct inode *cpfile, __u64 cno, int mode)
		* @cpstat: pointer to a structure of checkpoint statistics
		*
		* Description: nilfs_cpfile_get_stat() returns information about checkpoints.
		* The checkpoint statistics are stored in the location pointed to by @cpstat.
		*
		* Return Value: On success, 0 is returned, and checkpoints information is
		* stored in the place pointed by @cpstat. On error, one of the following
		* negative error codes is returned.
		*
		* %-EIO - I/O error.
		*
		* %-ENOMEM - Insufficient amount of memory available.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOMEM - Insufficient memory available.
		*/
		int nilfs_cpfile_get_stat(struct inode cpfile, struct nilfs_cpstat cpstat)
		{

fs/nilfs2/dat.c

+16 −24

Original line number	Diff line number	Diff line
		@@ -302,14 +302,11 @@ int nilfs_dat_mark_dirty(struct inode *dat, __u64 vblocknr)
		* Description: nilfs_dat_freev() frees the virtual block numbers specified by
		* @vblocknrs and @nitems.
		*
		* Return Value: On success, 0 is returned. On error, one of the following
		* negative error codes is returned.
		*
		* %-EIO - I/O error.
		*
		* %-ENOMEM - Insufficient amount of memory available.
		*
		* %-ENOENT - The virtual block number have not been allocated.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOENT - The virtual block number have not been allocated.
		* * %-ENOMEM - Insufficient memory available.
		*/
		int nilfs_dat_freev(struct inode dat, __u64 vblocknrs, size_t nitems)
		{
		@@ -325,12 +322,10 @@ int nilfs_dat_freev(struct inode dat, __u64 vblocknrs, size_t nitems)
		* Description: nilfs_dat_move() changes the block number associated with
		* @vblocknr to @blocknr.
		*
		* Return Value: On success, 0 is returned. On error, one of the following
		* negative error codes is returned.
		*
		* %-EIO - I/O error.
		*
		* %-ENOMEM - Insufficient amount of memory available.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOMEM - Insufficient memory available.
		*/
		int nilfs_dat_move(struct inode *dat, __u64 vblocknr, sector_t blocknr)
		{
		@@ -390,17 +385,14 @@ int nilfs_dat_move(struct inode *dat, __u64 vblocknr, sector_t blocknr)
		* @blocknrp: pointer to a block number
		*
		* Description: nilfs_dat_translate() maps the virtual block number @vblocknr
		* to the corresponding block number.
		*
		* Return Value: On success, 0 is returned and the block number associated
		* with @vblocknr is stored in the place pointed by @blocknrp. On error, one
		* of the following negative error codes is returned.
		*
		* %-EIO - I/O error.
		* to the corresponding block number. The block number associated with
		* @vblocknr is stored in the place pointed to by @blocknrp.
		*
		* %-ENOMEM - Insufficient amount of memory available.
		*
		* %-ENOENT - A block number associated with @vblocknr does not exist.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOENT - A block number associated with @vblocknr does not exist.
		* * %-ENOMEM - Insufficient memory available.
		*/
		int nilfs_dat_translate(struct inode dat, __u64 vblocknr, sector_t blocknrp)
		{

fs/nilfs2/ifile.c

+14 −18

Original line number	Diff line number	Diff line
		@@ -38,17 +38,16 @@ static inline struct nilfs_ifile_info NILFS_IFILE_I(struct inode ifile)
		* @out_ino: pointer to a variable to store inode number
		* @out_bh: buffer_head contains newly allocated disk inode
		*
		* Return Value: On success, 0 is returned and the newly allocated inode
		* number is stored in the place pointed by @ino, and buffer_head pointer
		* that contains newly allocated disk inode structure is stored in the
		* place pointed by @out_bh
		* On error, one of the following negative error codes is returned.
		* nilfs_ifile_create_inode() allocates a new inode in the ifile metadata
		* file and stores the inode number in the variable pointed to by @out_ino,
		* as well as storing the ifile's buffer with the disk inode in the location
		* pointed to by @out_bh.
		*
		* %-EIO - I/O error.
		*
		* %-ENOMEM - Insufficient amount of memory available.
		*
		* %-ENOSPC - No inode left.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOMEM - Insufficient memory available.
		* * %-ENOSPC - No inode left.
		*/
		int nilfs_ifile_create_inode(struct inode ifile, ino_t out_ino,
		struct buffer_head **out_bh)
		@@ -83,14 +82,11 @@ int nilfs_ifile_create_inode(struct inode ifile, ino_t out_ino,
		* @ifile: ifile inode
		* @ino: inode number
		*
		* Return Value: On success, 0 is returned. On error, one of the following
		* negative error codes is returned.
		*
		* %-EIO - I/O error.
		*
		* %-ENOMEM - Insufficient amount of memory available.
		*
		* %-ENOENT - The inode number @ino have not been allocated.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOENT - Inode number unallocated.
		* * %-ENOMEM - Insufficient memory available.
		*/
		int nilfs_ifile_delete_inode(struct inode *ifile, ino_t ino)
		{

fs/nilfs2/mdt.c

+27 −32

Original line number	Diff line number	Diff line
		@@ -226,20 +226,21 @@ static int nilfs_mdt_read_block(struct inode *inode, unsigned long block,
		* @out_bh: output of a pointer to the buffer_head
		*
		* nilfs_mdt_get_block() looks up the specified buffer and tries to create
		* a new buffer if @create is not zero. On success, the returned buffer is
		* assured to be either existing or formatted using a buffer lock on success.
		* @out_bh is substituted only when zero is returned.
		* a new buffer if @create is not zero. If (and only if) this function
		* succeeds, it stores a pointer to the retrieved buffer head in the location
		* pointed to by @out_bh.
		*
		* Return Value: On success, it returns 0. On error, the following negative
		* error code is returned.
		* The retrieved buffer may be either an existing one or a newly allocated one.
		* For a newly created buffer, if the callback function argument @init_block
		* is non-NULL, the callback will be called with the buffer locked to format
		* the block.
		*
		* %-ENOMEM - Insufficient memory available.
		*
		* %-EIO - I/O error
		*
		* %-ENOENT - the specified block does not exist (hole block)
		*
		* %-EROFS - Read only filesystem (for create mode)
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOENT - The specified block does not exist (hole block).
		* * %-ENOMEM - Insufficient memory available.
		* * %-EROFS - Read only filesystem (for create mode).
		*/
		int nilfs_mdt_get_block(struct inode *inode, unsigned long blkoff, int create,
		void (init_block)(struct inode ,
		@@ -275,14 +276,11 @@ int nilfs_mdt_get_block(struct inode *inode, unsigned long blkoff, int create,
		* @out_bh, and block offset to @blkoff, respectively. @out_bh and
		* @blkoff are substituted only when zero is returned.
		*
		* Return Value: On success, it returns 0. On error, the following negative
		* error code is returned.
		*
		* %-ENOMEM - Insufficient memory available.
		*
		* %-EIO - I/O error
		*
		* %-ENOENT - no block was found in the range
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOENT - No block was found in the range.
		* * %-ENOMEM - Insufficient memory available.
		*/
		int nilfs_mdt_find_block(struct inode *inode, unsigned long start,
		unsigned long end, unsigned long *blkoff,
		@@ -321,12 +319,11 @@ int nilfs_mdt_find_block(struct inode *inode, unsigned long start,
		* @inode: inode of the meta data file
		* @block: block offset
		*
		* Return Value: On success, zero is returned.
		* On error, one of the following negative error code is returned.
		*
		* %-ENOMEM - Insufficient memory available.
		*
		* %-EIO - I/O error
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EIO - I/O error (including metadata corruption).
		* * %-ENOENT - Non-existent block.
		* * %-ENOMEM - Insufficient memory available.
		*/
		int nilfs_mdt_delete_block(struct inode *inode, unsigned long block)
		{
		@@ -349,12 +346,10 @@ int nilfs_mdt_delete_block(struct inode *inode, unsigned long block)
		* nilfs_mdt_forget_block() clears a dirty flag of the specified buffer, and
		* tries to release the page including the buffer from a page cache.
		*
		* Return Value: On success, 0 is returned. On error, one of the following
		* negative error code is returned.
		*
		* %-EBUSY - page has an active buffer.
		*
		* %-ENOENT - page cache has no page addressed by the offset.
		* Return: 0 on success, or one of the following negative error codes on
		* failure:
		* * %-EBUSY - Page has an active buffer.
		* * %-ENOENT - Page cache has no page addressed by the offset.
		*/
		int nilfs_mdt_forget_block(struct inode *inode, unsigned long block)
		{