ext4: clean up kerneldoc warnigns when building with W=1
authorTheodore Ts'o <tytso@mit.edu>
Wed, 19 Jun 2019 20:30:03 +0000 (16:30 -0400)
committerTheodore Ts'o <tytso@mit.edu>
Wed, 19 Jun 2019 20:30:03 +0000 (16:30 -0400)
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
fs/ext4/balloc.c
fs/ext4/dir.c
fs/ext4/extents.c
fs/ext4/indirect.c
fs/ext4/mballoc.c
fs/ext4/move_extent.c

index e5d6ee6..0b202e0 100644 (file)
@@ -603,9 +603,9 @@ int ext4_claim_free_clusters(struct ext4_sb_info *sbi,
 }
 
 /**
- * ext4_should_retry_alloc()
+ * ext4_should_retry_alloc() - check if a block allocation should be retried
  * @sb:                        super block
- * @retries            number of attemps has been made
+ * @retries:           number of attemps has been made
  *
  * ext4_should_retry_alloc() is called when ENOSPC is returned, and if
  * it is profitable to retry the operation, this function will wait
index c7843b1..1f7784b 100644 (file)
@@ -33,6 +33,9 @@
 static int ext4_dx_readdir(struct file *, struct dir_context *);
 
 /**
+ * is_dx_dir() - check if a directory is using htree indexing
+ * @inode: directory inode
+ *
  * Check if the given dir-inode refers to an htree-indexed directory
  * (or a directory which could potentially get converted to use htree
  * indexing).
index d40ed94..92266a2 100644 (file)
@@ -5676,8 +5676,8 @@ out_mutex:
 }
 
 /**
- * ext4_swap_extents - Swap extents between two inodes
- *
+ * ext4_swap_extents() - Swap extents between two inodes
+ * @handle: handle for this transaction
  * @inode1:    First inode
  * @inode2:    Second inode
  * @lblk1:     Start block for first inode
index 2024d3f..36699a1 100644 (file)
@@ -294,14 +294,12 @@ static int ext4_blks_to_allocate(Indirect *branch, int k, unsigned int blks,
 }
 
 /**
- *     ext4_alloc_branch - allocate and set up a chain of blocks.
- *     @handle: handle for this transaction
- *     @inode: owner
- *     @indirect_blks: number of allocated indirect blocks
- *     @blks: number of allocated direct blocks
- *     @goal: preferred place for allocation
- *     @offsets: offsets (in the blocks) to store the pointers to next.
- *     @branch: place to store the chain in.
+ * ext4_alloc_branch() - allocate and set up a chain of blocks
+ * @handle: handle for this transaction
+ * @ar: structure describing the allocation request
+ * @indirect_blks: number of allocated indirect blocks
+ * @offsets: offsets (in the blocks) to store the pointers to next.
+ * @branch: place to store the chain in.
  *
  *     This function allocates blocks, zeroes out all but the last one,
  *     links them into chain and (if we are synchronous) writes them to disk.
@@ -396,15 +394,11 @@ failed:
 }
 
 /**
- * ext4_splice_branch - splice the allocated branch onto inode.
+ * ext4_splice_branch() - splice the allocated branch onto inode.
  * @handle: handle for this transaction
- * @inode: owner
- * @block: (logical) number of block we are adding
- * @chain: chain of indirect blocks (with a missing link - see
- *     ext4_alloc_branch)
+ * @ar: structure describing the allocation request
  * @where: location of missing link
  * @num:   number of indirect blocks we are adding
- * @blks:  number of direct blocks we are adding
  *
  * This function fills the missing link and does all housekeeping needed in
  * inode (->i_blocks, etc.). In case of success we end up with the full
index 99ba720..a3e2767 100644 (file)
@@ -4696,8 +4696,9 @@ ext4_mb_free_metadata(handle_t *handle, struct ext4_buddy *e4b,
  * ext4_free_blocks() -- Free given blocks and update quota
  * @handle:            handle for this transaction
  * @inode:             inode
- * @block:             start physical block to free
- * @count:             number of blocks to count
+ * @bh:                        optional buffer of the block to be freed
+ * @block:             starting physical block to be freed
+ * @count:             number of blocks to be freed
  * @flags:             flags used by ext4_free_blocks
  */
 void ext4_free_blocks(handle_t *handle, struct inode *inode,
index 1083a9f..3ec9627 100644 (file)
 #include "ext4_extents.h"
 
 /**
- * get_ext_path - Find an extent path for designated logical block number.
- *
- * @inode:     an inode which is searched
+ * get_ext_path() - Find an extent path for designated logical block number.
+ * @inode:     inode to be searched
  * @lblock:    logical block number to find an extent path
- * @path:      pointer to an extent path pointer (for output)
+ * @ppath:     pointer to an extent path pointer (for output)
  *
  * ext4_find_extent wrapper. Return 0 on success, or a negative error value
  * on failure.
@@ -42,8 +41,9 @@ get_ext_path(struct inode *inode, ext4_lblk_t lblock,
 }
 
 /**
- * ext4_double_down_write_data_sem - Acquire two inodes' write lock
- *                                   of i_data_sem
+ * ext4_double_down_write_data_sem() - write lock two inodes's i_data_sem
+ * @first: inode to be locked
+ * @second: inode to be locked
  *
  * Acquire write lock of i_data_sem of the two inodes
  */