diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2008-03-19 20:00:40 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2008-03-19 21:53:35 -0400 |
commit | 7682486b3ee06f800d5b11033371c7c5e92e3057 (patch) | |
tree | d0c2eda3204b085fc63200c787b2cf04f0298729 /mm/slab.c | |
parent | 6cb2a21049b8990df4576c5fce4d48d0206c22d5 (diff) |
mm: fix various kernel-doc comments
Fix various kernel-doc notation in mm/:
filemap.c: add function short description; convert 2 to kernel-doc
fremap.c: change parameter 'prot' to @prot
pagewalk.c: change "-" in function parameters to ":"
slab.c: fix short description of kmem_ptr_validate()
swap.c: fix description & parameters of put_pages_list()
swap_state.c: fix function parameters
vmalloc.c: change "@returns" to "Returns:" since that is not a parameter
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'mm/slab.c')
-rw-r--r-- | mm/slab.c | 5 |
1 files changed, 2 insertions, 3 deletions
@@ -3624,12 +3624,11 @@ void *kmem_cache_alloc(struct kmem_cache *cachep, gfp_t flags) | |||
3624 | EXPORT_SYMBOL(kmem_cache_alloc); | 3624 | EXPORT_SYMBOL(kmem_cache_alloc); |
3625 | 3625 | ||
3626 | /** | 3626 | /** |
3627 | * kmem_ptr_validate - check if an untrusted pointer might | 3627 | * kmem_ptr_validate - check if an untrusted pointer might be a slab entry. |
3628 | * be a slab entry. | ||
3629 | * @cachep: the cache we're checking against | 3628 | * @cachep: the cache we're checking against |
3630 | * @ptr: pointer to validate | 3629 | * @ptr: pointer to validate |
3631 | * | 3630 | * |
3632 | * This verifies that the untrusted pointer looks sane: | 3631 | * This verifies that the untrusted pointer looks sane; |
3633 | * it is _not_ a guarantee that the pointer is actually | 3632 | * it is _not_ a guarantee that the pointer is actually |
3634 | * part of the slab cache in question, but it at least | 3633 | * part of the slab cache in question, but it at least |
3635 | * validates that the pointer can be dereferenced and | 3634 | * validates that the pointer can be dereferenced and |