linux-kernel - [PATCH -mm] doc. fixes for readahead

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20070504144121.22b20030.randy.dunlap@oracle.com>
Date:	Fri, 4 May 2007 14:41:21 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	lkml <linux-kernel@...r.kernel.org>
Cc:	akpm <akpm@...ux-foundation.org>
Subject: [PATCH -mm] doc. fixes for readahead

From: Randy Dunlap <randy.dunlap@...cle.com>

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'

Signed-off-by: Randy Dunlap <randy.dunlap@...cle.com>
---
 mm/filemap.c   |    3 ++-
 mm/readahead.c |    7 ++++++-
 2 files changed, 8 insertions(+), 2 deletions(-)

--- linux-2621-rc7mm2.orig/mm/readahead.c
+++ linux-2621-rc7mm2/mm/readahead.c
@@ -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
--- linux-2621-rc7mm2.orig/mm/filemap.c
+++ linux-2621-rc7mm2/mm/filemap.c
@@ -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.
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/