Commit 46711810 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds

mm/shmem and tiny-shmem: fix some kernel-doc

Convert tiny-shmem.c function comments to kernel-doc.  Add parameters and
convert/fix other kernel-doc in shmem.c.
Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Cc: Hugh Dickins <hugh@veritas.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 7682486b
...@@ -244,9 +244,8 @@ static void shmem_free_inode(struct super_block *sb) ...@@ -244,9 +244,8 @@ static void shmem_free_inode(struct super_block *sb)
} }
} }
/* /**
* shmem_recalc_inode - recalculate the size of an inode * shmem_recalc_inode - recalculate the size of an inode
*
* @inode: inode to recalc * @inode: inode to recalc
* *
* We have to calculate the free blocks since the mm can drop * We have to calculate the free blocks since the mm can drop
...@@ -270,9 +269,8 @@ static void shmem_recalc_inode(struct inode *inode) ...@@ -270,9 +269,8 @@ static void shmem_recalc_inode(struct inode *inode)
} }
} }
/* /**
* shmem_swp_entry - find the swap vector position in the info structure * shmem_swp_entry - find the swap vector position in the info structure
*
* @info: info structure for the inode * @info: info structure for the inode
* @index: index of the page to find * @index: index of the page to find
* @page: optional page to add to the structure. Has to be preset to * @page: optional page to add to the structure. Has to be preset to
...@@ -374,13 +372,13 @@ static void shmem_swp_set(struct shmem_inode_info *info, swp_entry_t *entry, uns ...@@ -374,13 +372,13 @@ static void shmem_swp_set(struct shmem_inode_info *info, swp_entry_t *entry, uns
} }
} }
/* /**
* shmem_swp_alloc - get the position of the swap entry for the page. * shmem_swp_alloc - get the position of the swap entry for the page.
* If it does not exist allocate the entry.
*
* @info: info structure for the inode * @info: info structure for the inode
* @index: index of the page to find * @index: index of the page to find
* @sgp: check and recheck i_size? skip allocation? * @sgp: check and recheck i_size? skip allocation?
*
* If the entry does not exist, allocate it.
*/ */
static swp_entry_t *shmem_swp_alloc(struct shmem_inode_info *info, unsigned long index, enum sgp_type sgp) static swp_entry_t *shmem_swp_alloc(struct shmem_inode_info *info, unsigned long index, enum sgp_type sgp)
{ {
...@@ -440,9 +438,8 @@ static swp_entry_t *shmem_swp_alloc(struct shmem_inode_info *info, unsigned long ...@@ -440,9 +438,8 @@ static swp_entry_t *shmem_swp_alloc(struct shmem_inode_info *info, unsigned long
return entry; return entry;
} }
/* /**
* shmem_free_swp - free some swap entries in a directory * shmem_free_swp - free some swap entries in a directory
*
* @dir: pointer to the directory * @dir: pointer to the directory
* @edir: pointer after last entry of the directory * @edir: pointer after last entry of the directory
* @punch_lock: pointer to spinlock when needed for the holepunch case * @punch_lock: pointer to spinlock when needed for the holepunch case
...@@ -2022,7 +2019,7 @@ static const struct inode_operations shmem_symlink_inode_operations = { ...@@ -2022,7 +2019,7 @@ static const struct inode_operations shmem_symlink_inode_operations = {
}; };
#ifdef CONFIG_TMPFS_POSIX_ACL #ifdef CONFIG_TMPFS_POSIX_ACL
/** /*
* Superblocks without xattr inode operations will get security.* xattr * Superblocks without xattr inode operations will get security.* xattr
* support from the VFS "for free". As soon as we have any other xattrs * support from the VFS "for free". As soon as we have any other xattrs
* like ACLs, we also need to implement the security.* handlers at * like ACLs, we also need to implement the security.* handlers at
...@@ -2561,12 +2558,11 @@ static int __init init_tmpfs(void) ...@@ -2561,12 +2558,11 @@ static int __init init_tmpfs(void)
} }
module_init(init_tmpfs) module_init(init_tmpfs)
/* /**
* shmem_file_setup - get an unlinked file living in tmpfs * shmem_file_setup - get an unlinked file living in tmpfs
*
* @name: name for dentry (to be seen in /proc/<pid>/maps * @name: name for dentry (to be seen in /proc/<pid>/maps
* @size: size to be set for the file * @size: size to be set for the file
* * @flags: vm_flags
*/ */
struct file *shmem_file_setup(char *name, loff_t size, unsigned long flags) struct file *shmem_file_setup(char *name, loff_t size, unsigned long flags)
{ {
...@@ -2621,9 +2617,8 @@ struct file *shmem_file_setup(char *name, loff_t size, unsigned long flags) ...@@ -2621,9 +2617,8 @@ struct file *shmem_file_setup(char *name, loff_t size, unsigned long flags)
return ERR_PTR(error); return ERR_PTR(error);
} }
/* /**
* shmem_zero_setup - setup a shared anonymous mapping * shmem_zero_setup - setup a shared anonymous mapping
*
* @vma: the vma to be mmapped is prepared by do_mmap_pgoff * @vma: the vma to be mmapped is prepared by do_mmap_pgoff
*/ */
int shmem_zero_setup(struct vm_area_struct *vma) int shmem_zero_setup(struct vm_area_struct *vma)
......
...@@ -39,12 +39,11 @@ static int __init init_tmpfs(void) ...@@ -39,12 +39,11 @@ static int __init init_tmpfs(void)
} }
module_init(init_tmpfs) module_init(init_tmpfs)
/* /**
* shmem_file_setup - get an unlinked file living in tmpfs * shmem_file_setup - get an unlinked file living in tmpfs
*
* @name: name for dentry (to be seen in /proc/<pid>/maps * @name: name for dentry (to be seen in /proc/<pid>/maps
* @size: size to be set for the file * @size: size to be set for the file
* * @flags: vm_flags
*/ */
struct file *shmem_file_setup(char *name, loff_t size, unsigned long flags) struct file *shmem_file_setup(char *name, loff_t size, unsigned long flags)
{ {
...@@ -95,9 +94,8 @@ struct file *shmem_file_setup(char *name, loff_t size, unsigned long flags) ...@@ -95,9 +94,8 @@ struct file *shmem_file_setup(char *name, loff_t size, unsigned long flags)
return ERR_PTR(error); return ERR_PTR(error);
} }
/* /**
* shmem_zero_setup - setup a shared anonymous mapping * shmem_zero_setup - setup a shared anonymous mapping
*
* @vma: the vma to be mmapped is prepared by do_mmap_pgoff * @vma: the vma to be mmapped is prepared by do_mmap_pgoff
*/ */
int shmem_zero_setup(struct vm_area_struct *vma) int shmem_zero_setup(struct vm_area_struct *vma)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment