[PATCH v3 1/2] mm/sparse: Clean up the obsolete code comment

From: Baoquan He <bhe@redhat.com>
To: linux-kernel@vger.kernel.org
Cc: linux-mm@kvack.org, rafael@kernel.org, akpm@linux-foundation.org,
	mhocko@suse.com, osalvador@suse.de, rppt@linux.ibm.com,
	willy@infradead.org, fanc.fnst@cn.fujitsu.com,
	Baoquan He <bhe@redhat.com>
Subject: [PATCH v3 1/2] mm/sparse: Clean up the obsolete code comment
Date: Fri, 29 Mar 2019 16:29:14 +0800	[thread overview]
Message-ID: <20190329082915.19763-1-bhe@redhat.com> (raw)

The code comment above sparse_add_one_section() is obsolete and
incorrect, clean it up and write new one.

Signed-off-by: Baoquan He <bhe@redhat.com>
---
v2->v3:
  Normalize the code comment to use '/**' at 1st line of doc
  above function.
v1-v2:
  Add comments to explain what the returned value means for
  each error code.
 mm/sparse.c | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/mm/sparse.c b/mm/sparse.c
index 69904aa6165b..363f9d31b511 100644
--- a/mm/sparse.c
+++ b/mm/sparse.c
@@ -684,10 +684,19 @@ static void free_map_bootmem(struct page *memmap)
 #endif /* CONFIG_MEMORY_HOTREMOVE */
 #endif /* CONFIG_SPARSEMEM_VMEMMAP */
 
-/*
- * returns the number of sections whose mem_maps were properly
- * set.  If this is <=0, then that means that the passed-in
- * map was not consumed and must be freed.
+/**
+ * sparse_add_one_section - add a memory section
+ * @nid: The node to add section on
+ * @start_pfn: start pfn of the memory range
+ * @altmap: device page map
+ *
+ * This is only intended for hotplug.
+ *
+ * Returns:
+ *   0 on success.
+ *   Other error code on failure:
+ *     - -EEXIST - section has been present.
+ *     - -ENOMEM - out of memory.
  */
 int __meminit sparse_add_one_section(int nid, unsigned long start_pfn,
 				     struct vmem_altmap *altmap)
-- 
2.17.2

