lkml.org 
[lkml]   [2020]   [Apr]   [27]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH] mm/gup.c: Updating the documentation
From
Date
On 4/27/20 12:26 PM, Andrew Morton wrote:
> On Tue, 28 Apr 2020 00:23:50 +0530 Souptick Joarder <jrdr.linux@gmail.com> wrote:
>
>> This patch is an attempt to update the documentation.
>>
>> * Adding / removing extra * based on type of function
>> static / global.
>
> I don't think so, unless this is a new kerneldoc convention?

It's not new, but we generally try harder to document exported or
non-private interfaces and not so hard on private interfaces.

>> --- a/mm/gup.c
>> +++ b/mm/gup.c
>> @@ -722,7 +722,7 @@ static struct page *follow_p4d_mask(struct vm_area_struct *vma,
>> return follow_pud_mask(vma, address, p4d, flags, ctx);
>> }
>>
>> -/**
>> +/*
>> * follow_page_mask - look up a page descriptor from a user-virtual address
>> * @vma: vm_area_struct mapping @address
>> * @address: virtual address to look up
>
> /** indicates that the comment is in kerneldoc form, not that it has
> static scope?

Right.

--
~Randy

\
 
 \ /
  Last update: 2020-04-27 21:32    [W:0.944 / U:0.604 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site