On Fri, Mar 29, 2019 at 04:29:14PM +0800, Baoquan He wrote: > The code comment above sparse_add_one_section() is obsolete and > incorrect, clean it up and write new one. > > Signed-off-by: Baoquan He <b...@redhat.com>
Reviewed-by: Oscar Salvador <osalva...@suse.de> > --- > 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. I am not really into kernel-doc format, but I thought it was something like: <-- Return: 0: success -EEXIST: Section is already present -ENOMEM: Out of memory --> But as I said, I might very well be wrong. -- Oscar Salvador SUSE L3
