mm: docs: fixup punctuation
authorMike Rapoport <rppt@linux.vnet.ibm.com>
Tue, 6 Feb 2018 23:42:13 +0000 (15:42 -0800)
committerLinus Torvalds <torvalds@linux-foundation.org>
Wed, 7 Feb 2018 02:32:48 +0000 (18:32 -0800)
so that kernel-doc will properly recognize the parameter and function
descriptions.

Link: http://lkml.kernel.org/r/1516700871-22279-2-git-send-email-rppt@linux.vnet.ibm.com
Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
mm/ksm.c
mm/memcontrol.c
mm/mlock.c
mm/nommu.c
mm/zpool.c

index c406f75957ad49c646c12559d8f2f58f4713a715..293721f5da702ade0da55724702e0dbe6bf6422c 100644 (file)
--- a/mm/ksm.c
+++ b/mm/ksm.c
@@ -2302,7 +2302,7 @@ next_mm:
 
 /**
  * ksm_do_scan  - the ksm scanner main worker function.
- * @scan_npages - number of pages we want to scan before we return.
+ * @scan_npages number of pages we want to scan before we return.
  */
 static void ksm_do_scan(unsigned int scan_npages)
 {
index 0937f2c52c7ddd5e37e91aeee70a85f6adb349b3..3793e22977c05a7ab4b0c2407c8979b9020af2d4 100644 (file)
@@ -5818,8 +5818,8 @@ bool mem_cgroup_charge_skmem(struct mem_cgroup *memcg, unsigned int nr_pages)
 
 /**
  * mem_cgroup_uncharge_skmem - uncharge socket memory
- * @memcg - memcg to uncharge
- * @nr_pages - number of pages to uncharge
+ * @memcg: memcg to uncharge
+ * @nr_pages: number of pages to uncharge
  */
 void mem_cgroup_uncharge_skmem(struct mem_cgroup *memcg, unsigned int nr_pages)
 {
index f7f54fd2e13fa343916853bd366bb090fb9d5467..79398200e423b033e71a9f2a7210811c627020a0 100644 (file)
@@ -157,7 +157,7 @@ static void __munlock_isolation_failed(struct page *page)
 
 /**
  * munlock_vma_page - munlock a vma page
- * @page - page to be unlocked, either a normal page or THP page head
+ * @page: page to be unlocked, either a normal page or THP page head
  *
  * returns the size of the page as a page mask (0 for normal page,
  *         HPAGE_PMD_NR - 1 for THP head page)
index 4b9864b17cb0e822d6cba744110c0a4dd8ef0698..ebb6e618dade241084f10a07555af5b92a118e66 100644 (file)
@@ -1836,7 +1836,7 @@ int __access_remote_vm(struct task_struct *tsk, struct mm_struct *mm,
 }
 
 /**
- * @access_remote_vm - access another process' address space
+ * access_remote_vm - access another process' address space
  * @mm:                the mm_struct of the target address space
  * @addr:      start address to access
  * @buf:       source or destination buffer
index e1e7aa6d1d064d40f7735476fe9ee366c354b57f..be67bcffb9ef1ddd70f93ac664d1730d2dcb1d45 100644 (file)
@@ -101,7 +101,7 @@ static void zpool_put_driver(struct zpool_driver *driver)
 
 /**
  * zpool_has_pool() - Check if the pool driver is available
- * @type       The type of the zpool to check (e.g. zbud, zsmalloc)
+ * @type:      The type of the zpool to check (e.g. zbud, zsmalloc)
  *
  * This checks if the @type pool driver is available.  This will try to load
  * the requested module, if needed, but there is no guarantee the module will
@@ -136,10 +136,10 @@ EXPORT_SYMBOL(zpool_has_pool);
 
 /**
  * zpool_create_pool() - Create a new zpool
- * @type       The type of the zpool to create (e.g. zbud, zsmalloc)
- * @name       The name of the zpool (e.g. zram0, zswap)
- * @gfp                The GFP flags to use when allocating the pool.
- * @ops                The optional ops callback.
+ * @type:      The type of the zpool to create (e.g. zbud, zsmalloc)
+ * @name:      The name of the zpool (e.g. zram0, zswap)
+ * @gfp:       The GFP flags to use when allocating the pool.
+ * @ops:       The optional ops callback.
  *
  * This creates a new zpool of the specified type.  The gfp flags will be
  * used when allocating memory, if the implementation supports it.  If the
@@ -201,7 +201,7 @@ struct zpool *zpool_create_pool(const char *type, const char *name, gfp_t gfp,
 
 /**
  * zpool_destroy_pool() - Destroy a zpool
- * @pool       The zpool to destroy.
+ * @pool:      The zpool to destroy.
  *
  * Implementations must guarantee this to be thread-safe,
  * however only when destroying different pools.  The same
@@ -224,7 +224,7 @@ void zpool_destroy_pool(struct zpool *zpool)
 
 /**
  * zpool_get_type() - Get the type of the zpool
- * @pool       The zpool to check
+ * @pool:      The zpool to check
  *
  * This returns the type of the pool.
  *
@@ -239,10 +239,10 @@ const char *zpool_get_type(struct zpool *zpool)
 
 /**
  * zpool_malloc() - Allocate memory
- * @pool       The zpool to allocate from.
- * @size       The amount of memory to allocate.
- * @gfp                The GFP flags to use when allocating memory.
- * @handle     Pointer to the handle to set
+ * @pool:      The zpool to allocate from.
+ * @size:      The amount of memory to allocate.
+ * @gfp:       The GFP flags to use when allocating memory.
+ * @handle:    Pointer to the handle to set
  *
  * This allocates the requested amount of memory from the pool.
  * The gfp flags will be used when allocating memory, if the
@@ -261,8 +261,8 @@ int zpool_malloc(struct zpool *zpool, size_t size, gfp_t gfp,
 
 /**
  * zpool_free() - Free previously allocated memory
- * @pool       The zpool that allocated the memory.
- * @handle     The handle to the memory to free.
+ * @pool:      The zpool that allocated the memory.
+ * @handle:    The handle to the memory to free.
  *
  * This frees previously allocated memory.  This does not guarantee
  * that the pool will actually free memory, only that the memory
@@ -280,9 +280,9 @@ void zpool_free(struct zpool *zpool, unsigned long handle)
 
 /**
  * zpool_shrink() - Shrink the pool size
- * @pool       The zpool to shrink.
- * @pages      The number of pages to shrink the pool.
- * @reclaimed  The number of pages successfully evicted.
+ * @pool:      The zpool to shrink.
+ * @pages:     The number of pages to shrink the pool.
+ * @reclaimed: The number of pages successfully evicted.
  *
  * This attempts to shrink the actual memory size of the pool
  * by evicting currently used handle(s).  If the pool was
@@ -304,9 +304,9 @@ int zpool_shrink(struct zpool *zpool, unsigned int pages,
 
 /**
  * zpool_map_handle() - Map a previously allocated handle into memory
- * @pool       The zpool that the handle was allocated from
- * @handle     The handle to map
- * @mm         How the memory should be mapped
+ * @pool:      The zpool that the handle was allocated from
+ * @handle:    The handle to map
+ * @mm:                How the memory should be mapped
  *
  * This maps a previously allocated handle into memory.  The @mm
  * param indicates to the implementation how the memory will be
@@ -332,8 +332,8 @@ void *zpool_map_handle(struct zpool *zpool, unsigned long handle,
 
 /**
  * zpool_unmap_handle() - Unmap a previously mapped handle
- * @pool       The zpool that the handle was allocated from
- * @handle     The handle to unmap
+ * @pool:      The zpool that the handle was allocated from
+ * @handle:    The handle to unmap
  *
  * This unmaps a previously mapped handle.  Any locks or other
  * actions that the implementation took in zpool_map_handle()
@@ -347,7 +347,7 @@ void zpool_unmap_handle(struct zpool *zpool, unsigned long handle)
 
 /**
  * zpool_get_total_size() - The total size of the pool
- * @pool       The zpool to check
+ * @pool:      The zpool to check
  *
  * This returns the total size in bytes of the pool.
  *