arm64/mm: fix kernel-doc comments

Building a kernel with W=1 generates several warnings due to abuse of
kernel-doc comments:

  | arch/arm64/mm/numa.c:281: warning: Cannot understand  *
  |   on line 281 - I thought it was a doc line

Tidy up the comments to remove the warnings.

Fixes: 1a2db30034 ("arm64, numa: Add NUMA support for arm64 platforms.")
Signed-off-by: Qian Cai <cai@lca.pw>
Signed-off-by: Will Deacon <will.deacon@arm.com>
This commit is contained in:
Qian Cai 2019-03-14 12:16:19 -04:00 committed by Will Deacon
parent 344bf332ce
commit b1ce45e86b

View File

@ -124,7 +124,7 @@ static void __init setup_node_to_cpumask_map(void)
} }
/* /*
* Set the cpu to node and mem mapping * Set the cpu to node and mem mapping
*/ */
void numa_store_cpu_info(unsigned int cpu) void numa_store_cpu_info(unsigned int cpu)
{ {
@ -200,7 +200,7 @@ void __init setup_per_cpu_areas(void)
#endif #endif
/** /**
* numa_add_memblk - Set node id to memblk * numa_add_memblk() - Set node id to memblk
* @nid: NUMA node ID of the new memblk * @nid: NUMA node ID of the new memblk
* @start: Start address of the new memblk * @start: Start address of the new memblk
* @end: End address of the new memblk * @end: End address of the new memblk
@ -223,7 +223,7 @@ int __init numa_add_memblk(int nid, u64 start, u64 end)
return ret; return ret;
} }
/** /*
* Initialize NODE_DATA for a node on the local memory * Initialize NODE_DATA for a node on the local memory
*/ */
static void __init setup_node_data(int nid, u64 start_pfn, u64 end_pfn) static void __init setup_node_data(int nid, u64 start_pfn, u64 end_pfn)
@ -257,7 +257,7 @@ static void __init setup_node_data(int nid, u64 start_pfn, u64 end_pfn)
NODE_DATA(nid)->node_spanned_pages = end_pfn - start_pfn; NODE_DATA(nid)->node_spanned_pages = end_pfn - start_pfn;
} }
/** /*
* numa_free_distance * numa_free_distance
* *
* The current table is freed. * The current table is freed.
@ -277,10 +277,8 @@ void __init numa_free_distance(void)
numa_distance = NULL; numa_distance = NULL;
} }
/** /*
*
* Create a new NUMA distance table. * Create a new NUMA distance table.
*
*/ */
static int __init numa_alloc_distance(void) static int __init numa_alloc_distance(void)
{ {
@ -311,7 +309,7 @@ static int __init numa_alloc_distance(void)
} }
/** /**
* numa_set_distance - Set inter node NUMA distance from node to node. * numa_set_distance() - Set inter node NUMA distance from node to node.
* @from: the 'from' node to set distance * @from: the 'from' node to set distance
* @to: the 'to' node to set distance * @to: the 'to' node to set distance
* @distance: NUMA distance * @distance: NUMA distance
@ -321,7 +319,6 @@ static int __init numa_alloc_distance(void)
* *
* If @from or @to is higher than the highest known node or lower than zero * If @from or @to is higher than the highest known node or lower than zero
* or @distance doesn't make sense, the call is ignored. * or @distance doesn't make sense, the call is ignored.
*
*/ */
void __init numa_set_distance(int from, int to, int distance) void __init numa_set_distance(int from, int to, int distance)
{ {
@ -347,7 +344,7 @@ void __init numa_set_distance(int from, int to, int distance)
numa_distance[from * numa_distance_cnt + to] = distance; numa_distance[from * numa_distance_cnt + to] = distance;
} }
/** /*
* Return NUMA distance @from to @to * Return NUMA distance @from to @to
*/ */
int __node_distance(int from, int to) int __node_distance(int from, int to)
@ -422,13 +419,15 @@ out_free_distance:
} }
/** /**
* dummy_numa_init - Fallback dummy NUMA init * dummy_numa_init() - Fallback dummy NUMA init
* *
* Used if there's no underlying NUMA architecture, NUMA initialization * Used if there's no underlying NUMA architecture, NUMA initialization
* fails, or NUMA is disabled on the command line. * fails, or NUMA is disabled on the command line.
* *
* Must online at least one node (node 0) and add memory blocks that cover all * Must online at least one node (node 0) and add memory blocks that cover all
* allowed memory. It is unlikely that this function fails. * allowed memory. It is unlikely that this function fails.
*
* Return: 0 on success, -errno on failure.
*/ */
static int __init dummy_numa_init(void) static int __init dummy_numa_init(void)
{ {
@ -454,9 +453,9 @@ static int __init dummy_numa_init(void)
} }
/** /**
* arm64_numa_init - Initialize NUMA * arm64_numa_init() - Initialize NUMA
* *
* Try each configured NUMA initialization method until one succeeds. The * Try each configured NUMA initialization method until one succeeds. The
* last fallback is dummy single node config encomapssing whole memory. * last fallback is dummy single node config encomapssing whole memory.
*/ */
void __init arm64_numa_init(void) void __init arm64_numa_init(void)