diff mbox series

[07/14] mm/memory_hotplug: Fix kerneldoc comment for __try_online_node

Message ID 20210520084809.8576-8-mgorman@techsingularity.net (mailing list archive)
State New, archived
Headers show
Series Clean W=1 build warnings for mm/ | expand

Commit Message

Mel Gorman May 20, 2021, 8:48 a.m. UTC
make W=1 generates the following warning for try_online_node

mm/memory_hotplug.c:1087: warning: expecting prototype for try_online_node(). Prototype was for __try_online_node() instead

Commit b9ff036082cd ("mm/memory_hotplug.c: make add_memory_resource use
__try_online_node") renamed the function but did not update the associated
kerneldoc. The function is static and somewhat specialised in nature
so it's not clear it warrants being a kerneldoc by moving the comment
to try_online_node. Hence, leave the comment of the internal helper in
place but leave it out of kerneldoc and correct the function name in
the comment.

Fixes: Commit b9ff036082cd ("mm/memory_hotplug.c: make add_memory_resource use __try_online_node")
Signed-off-by: Mel Gorman <mgorman@techsingularity.net>
---
 mm/memory_hotplug.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

David Hildenbrand May 20, 2021, 10:42 a.m. UTC | #1
On 20.05.21 10:48, Mel Gorman wrote:
> make W=1 generates the following warning for try_online_node
> 
> mm/memory_hotplug.c:1087: warning: expecting prototype for try_online_node(). Prototype was for __try_online_node() instead
> 
> Commit b9ff036082cd ("mm/memory_hotplug.c: make add_memory_resource use
> __try_online_node") renamed the function but did not update the associated
> kerneldoc. The function is static and somewhat specialised in nature
> so it's not clear it warrants being a kerneldoc by moving the comment
> to try_online_node. Hence, leave the comment of the internal helper in
> place but leave it out of kerneldoc and correct the function name in
> the comment.
> 
> Fixes: Commit b9ff036082cd ("mm/memory_hotplug.c: make add_memory_resource use __try_online_node")
> Signed-off-by: Mel Gorman <mgorman@techsingularity.net>
> ---
>   mm/memory_hotplug.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/mm/memory_hotplug.c b/mm/memory_hotplug.c
> index 70620d0dd923..e3266be1d020 100644
> --- a/mm/memory_hotplug.c
> +++ b/mm/memory_hotplug.c
> @@ -1072,8 +1072,8 @@ static void rollback_node_hotadd(int nid)
>   }
>   
>   
> -/**
> - * try_online_node - online a node if offlined
> +/*
> + * __try_online_node - online a node if offlined
>    * @nid: the node ID
>    * @set_node_online: Whether we want to online the node
>    * called by cpu_up() to online a node without onlined memory.
> 

Reviewed-by: David Hildenbrand <david@redhat.com>
diff mbox series

Patch

diff --git a/mm/memory_hotplug.c b/mm/memory_hotplug.c
index 70620d0dd923..e3266be1d020 100644
--- a/mm/memory_hotplug.c
+++ b/mm/memory_hotplug.c
@@ -1072,8 +1072,8 @@  static void rollback_node_hotadd(int nid)
 }
 
 
-/**
- * try_online_node - online a node if offlined
+/*
+ * __try_online_node - online a node if offlined
  * @nid: the node ID
  * @set_node_online: Whether we want to online the node
  * called by cpu_up() to online a node without onlined memory.