[PATCH 1/1 linux-next] gfs2: kerneldoc warning fixes

[PATCH 1/1 linux-next] gfs2: kerneldoc warning fixes

[Fabian Frederick]

Fixes the following kernel-doc warnings:
Warning(fs/gfs2/aops.c:180): No description found for parameter 'wbc'
Warning(fs/gfs2/aops.c:236): No description found for parameter 'end'
Warning(fs/gfs2/aops.c:236): No description found for parameter 'done_index'
Warning(fs/gfs2/aops.c:236): Excess function parameter 'writepage' description in 'gfs2_write_jdata_pagevec'
Warning(fs/gfs2/aops.c:346): Excess function parameter 'writepage' description in 'gfs2_write_cache_jdata'
Warning(fs/gfs2/aops.c:346): Excess function parameter 'data' description in 'gfs2_write_cache_jdata'
Warning(fs/gfs2/aops.c:605): No description found for parameter 'file'
Warning(fs/gfs2/aops.c:605): No description found for parameter 'mapping'
Warning(fs/gfs2/aops.c:605): No description found for parameter 'pages'
Warning(fs/gfs2/aops.c:605): No description found for parameter 'nr_pages'
Warning(fs/gfs2/aops.c:870): No description found for parameter 'copied'

Signed-off-by: Fabian Frederick <fabf@skynet.be>
---
 fs/gfs2/aops.c | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/fs/gfs2/aops.c b/fs/gfs2/aops.c
index 5551fea..1caee05 100644
--- a/fs/gfs2/aops.c
+++ b/fs/gfs2/aops.c
@@ -171,6 +171,7 @@ static int __gfs2_jdata_writepage(struct page *page, struct writeback_control *w
 /**
  * gfs2_jdata_writepage - Write complete page
  * @page: Page to write
+ * @wbc: The writeback control
  *
  * Returns: errno
  *
@@ -221,9 +222,10 @@ static int gfs2_writepages(struct address_space *mapping,
  * gfs2_write_jdata_pagevec - Write back a pagevec's worth of pages
  * @mapping: The mapping
  * @wbc: The writeback control
- * @writepage: The writepage function to call for each page
  * @pvec: The vector of pages
  * @nr_pages: The number of pages to write
+ * @end: End position
+ * @done_index: Page index
  *
  * Returns: non-zero if loop should terminate, zero otherwise
  */
@@ -333,8 +335,6 @@ continue_unlock:
  * gfs2_write_cache_jdata - Like write_cache_pages but different
  * @mapping: The mapping to write
  * @wbc: The writeback control
- * @writepage: The writepage function to call
- * @data: The data to pass to writepage
  *
  * The reason that we use our own function here is that we need to
  * start transactions before we grab page locks. This allows us
@@ -588,6 +588,10 @@ int gfs2_internal_read(struct gfs2_inode *ip, char *buf, loff_t *pos,
 
 /**
  * gfs2_readpages - Read a bunch of pages at once
+ * @file: The file to read from
+ * @mapping: Address space info
+ * @pages: List of pages to read
+ * @nr_pages: Number of pages to read
  *
  * Some notes:
  * 1. This is only for readahead, so we can simply ignore any things
@@ -853,7 +857,7 @@ static int gfs2_stuffed_write_end(struct inode *inode, struct buffer_head *dibh,
  * @mapping: The address space to write to
  * @pos: The file position
  * @len: The length of the data
- * @copied:
+ * @copied: How much was actually copied by the VFS
  * @page: The page that has been written
  * @fsdata: The fsdata (unused in GFS2)
  *
-- 
1.9.1

Re: [PATCH 1/1 linux-next] gfs2: kerneldoc warning fixes

[Bob Peterson]

----- Original Message -----
> Fixes the following kernel-doc warnings:
> Warning(fs/gfs2/aops.c:180): No description found for parameter 'wbc'
> Warning(fs/gfs2/aops.c:236): No description found for parameter 'end'
> Warning(fs/gfs2/aops.c:236): No description found for parameter 'done_index'
> Warning(fs/gfs2/aops.c:236): Excess function parameter 'writepage'
> description in 'gfs2_write_jdata_pagevec'
> Warning(fs/gfs2/aops.c:346): Excess function parameter 'writepage'
> description in 'gfs2_write_cache_jdata'
> Warning(fs/gfs2/aops.c:346): Excess function parameter 'data' description in
> 'gfs2_write_cache_jdata'
> Warning(fs/gfs2/aops.c:605): No description found for parameter 'file'
> Warning(fs/gfs2/aops.c:605): No description found for parameter 'mapping'
> Warning(fs/gfs2/aops.c:605): No description found for parameter 'pages'
> Warning(fs/gfs2/aops.c:605): No description found for parameter 'nr_pages'
> Warning(fs/gfs2/aops.c:870): No description found for parameter 'copied'
> 
> Signed-off-by: Fabian Frederick <fabf@skynet.be>

Hi,

Thanks. Now in the for-next branch of the linux-gfs2 tree:
https://git.kernel.org/cgit/linux/kernel/git/gfs2/linux-gfs2.git/commit/fs/gfs2?h=for-next&id=1272574bf94874a644ea82fad321034c15b157ac

Regards,

Bob Peterson
Red Hat File Systems