Skip to contentSkip to conversation

doc. fixes for readahead

PATCH New Randy Dunlap 1 participant 1 message May 4, 2007

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc. fixes for readahead

From: Randy Dunlap <[email protected]>

Fix mm/readahead.c & filemap.c kernel-doc warnings (goes with readahead patch when it's submitted).

Warning(/tester/linsrc/linux-2621-rc7mm2//mm/readahead.c:1633): No description found for parameter 'mapping' Warning(/tester/linsrc/linux-2621-rc7mm2//mm/readahead.c:1633): No description found for parameter 'ra' Warning(/tester/linsrc/linux-2621-rc7mm2//mm/readahead.c:1633): No description found for parameter 'filp' Warning(/tester/linsrc/linux-2621-rc7mm2//mm/readahead.c:1633): No description found for parameter 'offset' Warning(/tester/linsrc/linux-2621-rc7mm2//mm/readahead.c:1633): No description found for parameter 'req_size' Warning(/tester/linsrc/linux-2621-rc7mm2//mm/filemap.c:1394): No description found for parameter 'vma' Warning(/tester/linsrc/linux-2621-rc7mm2//mm/filemap.c:1394): No description found for parameter 'fdata'

---
 mm/filemap.c   |    3 ++-
 mm/readahead.c |    7 ++++++-
 2 files changed, 8 insertions(+), 2 deletions(-)
mm/readahead.c +6 -1
@@ -1610,8 +1610,13 @@ thrashing_recovery_readahead(struct addr
 
 /**
  * page_cache_readahead_adaptive - thrashing safe adaptive read-ahead
- * @mapping, @ra, @filp, @offset, @req_size: the same as page_cache_readahead()
+ * @mapping: address_space which holds the pagecache and I/O vectors
+ * @ra: file_ra_state which holds the readahead state
+ * @filp: passed on to ->readpage() and ->readpages()
  * @page: the page at @offset, or NULL if non-present
+ * @offset: start offset into @mapping, in PAGE_CACHE_SIZE units
+ * @req_size: hint: total size of the read which the caller is performing in
+ *            PAGE_CACHE_SIZE units
  *
  * page_cache_readahead_adaptive() is the entry point of the adaptive
  * read-ahead logic. It tries a set of methods in turn to determine the
mm/filemap.c +2 -1
@@ -1381,7 +1381,8 @@ static int fastcall page_cache_read(stru
 
 /**
  * filemap_fault - read in file data for page fault handling
- * @data:	the applicable fault_data
+ * @vma:	user vma (not used)
+ * @fdata:	the applicable fault_data
  *
  * filemap_fault() is invoked via the vma operations vector for a
  * mapped memory region to read in file data during a page fault.