clean-up-kerneldoc-warnings

   1 ext4: clean up kerneldoc warnigns when building with W=1
   2
   3 Signed-off-by: Theodore Ts'o <tytso@mit.edu>
   4 diff --git a/fs/ext4/balloc.c b/fs/ext4/balloc.c
   5 index e5d6ee61ff48..0b202e00d93f 100644
   6 --- a/fs/ext4/balloc.c
   7 +++ b/fs/ext4/balloc.c
   8 @@ -603,9 +603,9 @@ int ext4_claim_free_clusters(struct ext4_sb_info *sbi,
   9  }
  10
  11  /**
  12 - * ext4_should_retry_alloc()
  13 + * ext4_should_retry_alloc() - check if a block allocation should be retried
  14   * @sb:                        super block
  15 - * @retries            number of attemps has been made
  16 + * @retries:           number of attemps has been made
  17   *
  18   * ext4_should_retry_alloc() is called when ENOSPC is returned, and if
  19   * it is profitable to retry the operation, this function will wait
  20 diff --git a/fs/ext4/dir.c b/fs/ext4/dir.c
  21 index c7843b149a1e..1f7784bee42a 100644
  22 --- a/fs/ext4/dir.c
  23 +++ b/fs/ext4/dir.c
  24 @@ -33,6 +33,9 @@
  25  static int ext4_dx_readdir(struct file *, struct dir_context *);
  26
  27  /**
  28 + * is_dx_dir() - check if a directory is using htree indexing
  29 + * @inode: directory inode
  30 + *
  31   * Check if the given dir-inode refers to an htree-indexed directory
  32   * (or a directory which could potentially get converted to use htree
  33   * indexing).
  34 diff --git a/fs/ext4/extents.c b/fs/ext4/extents.c
  35 index d40ed940001e..92266a2da7d6 100644
  36 --- a/fs/ext4/extents.c
  37 +++ b/fs/ext4/extents.c
  38 @@ -5676,8 +5676,8 @@ int ext4_insert_range(struct inode *inode, loff_t offset, loff_t len)
  39  }
  40
  41  /**
  42 - * ext4_swap_extents - Swap extents between two inodes
  43 - *
  44 + * ext4_swap_extents() - Swap extents between two inodes
  45 + * @handle: handle for this transaction
  46   * @inode1:    First inode
  47   * @inode2:    Second inode
  48   * @lblk1:     Start block for first inode
  49 diff --git a/fs/ext4/indirect.c b/fs/ext4/indirect.c
  50 index 2024d3fa5504..36699a131168 100644
  51 --- a/fs/ext4/indirect.c
  52 +++ b/fs/ext4/indirect.c
  53 @@ -294,14 +294,12 @@ static int ext4_blks_to_allocate(Indirect *branch, int k, unsigned int blks,
  54  }
  55
  56  /**
  57 - *     ext4_alloc_branch - allocate and set up a chain of blocks.
  58 - *     @handle: handle for this transaction
  59 - *     @inode: owner
  60 - *     @indirect_blks: number of allocated indirect blocks
  61 - *     @blks: number of allocated direct blocks
  62 - *     @goal: preferred place for allocation
  63 - *     @offsets: offsets (in the blocks) to store the pointers to next.
  64 - *     @branch: place to store the chain in.
  65 + * ext4_alloc_branch() - allocate and set up a chain of blocks
  66 + * @handle: handle for this transaction
  67 + * @ar: structure describing the allocation request
  68 + * @indirect_blks: number of allocated indirect blocks
  69 + * @offsets: offsets (in the blocks) to store the pointers to next.
  70 + * @branch: place to store the chain in.
  71   *
  72   *     This function allocates blocks, zeroes out all but the last one,
  73   *     links them into chain and (if we are synchronous) writes them to disk.
  74 @@ -396,15 +394,11 @@ static int ext4_alloc_branch(handle_t *handle,
  75  }
  76
  77  /**
  78 - * ext4_splice_branch - splice the allocated branch onto inode.
  79 + * ext4_splice_branch() - splice the allocated branch onto inode.
  80   * @handle: handle for this transaction
  81 - * @inode: owner
  82 - * @block: (logical) number of block we are adding
  83 - * @chain: chain of indirect blocks (with a missing link - see
  84 - *     ext4_alloc_branch)
  85 + * @ar: structure describing the allocation request
  86   * @where: location of missing link
  87   * @num:   number of indirect blocks we are adding
  88 - * @blks:  number of direct blocks we are adding
  89   *
  90   * This function fills the missing link and does all housekeeping needed in
  91   * inode (->i_blocks, etc.). In case of success we end up with the full
  92 diff --git a/fs/ext4/mballoc.c b/fs/ext4/mballoc.c
  93 index 99ba720dbb7a..a3e2767bdf2f 100644
  94 --- a/fs/ext4/mballoc.c
  95 +++ b/fs/ext4/mballoc.c
  96 @@ -4696,8 +4696,9 @@ ext4_mb_free_metadata(handle_t *handle, struct ext4_buddy *e4b,
  97   * ext4_free_blocks() -- Free given blocks and update quota
  98   * @handle:            handle for this transaction
  99   * @inode:             inode
 100 - * @block:             start physical block to free
 101 - * @count:             number of blocks to count
 102 + * @bh:                        optional buffer of the block to be freed
 103 + * @block:             starting physical block to be freed
 104 + * @count:             number of blocks to be freed
 105   * @flags:             flags used by ext4_free_blocks
 106   */
 107  void ext4_free_blocks(handle_t *handle, struct inode *inode,
 108 diff --git a/fs/ext4/move_extent.c b/fs/ext4/move_extent.c
 109 index 1083a9f3f16a..3ec9627c9713 100644
 110 --- a/fs/ext4/move_extent.c
 111 +++ b/fs/ext4/move_extent.c
 112 @@ -13,11 +13,10 @@
 113  #include "ext4_extents.h"
 114
 115  /**
 116 - * get_ext_path - Find an extent path for designated logical block number.
 117 - *
 118 - * @inode:     an inode which is searched
 119 + * get_ext_path() - Find an extent path for designated logical block number.
 120 + * @inode:     inode to be searched
 121   * @lblock:    logical block number to find an extent path
 122 - * @path:      pointer to an extent path pointer (for output)
 123 + * @ppath:     pointer to an extent path pointer (for output)
 124   *
 125   * ext4_find_extent wrapper. Return 0 on success, or a negative error value
 126   * on failure.
 127 @@ -42,8 +41,9 @@ get_ext_path(struct inode *inode, ext4_lblk_t lblock,
 128  }
 129
 130  /**
 131 - * ext4_double_down_write_data_sem - Acquire two inodes' write lock
 132 - *                                   of i_data_sem
 133 + * ext4_double_down_write_data_sem() - write lock two inodes's i_data_sem
 134 + * @first: inode to be locked
 135 + * @second: inode to be locked
 136   *
 137   * Acquire write lock of i_data_sem of the two inodes
 138   */