Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH] mm/gup.c: Updating the documentation
To:     Andrew Morton <akpm@linux-foundation.org>,
        Souptick Joarder <jrdr.linux@gmail.com>
Cc:     linux-mm@kvack.org, linux-kernel@vger.kernel.org
References: <1588013630-4497-1-git-send-email-jrdr.linux@gmail.com>
 <20200427122606.dc29c381f6da47831a40d365@linux-foundation.org>
From:   Randy Dunlap <rdunlap@infradead.org>
Message-ID: <152176e4-9200-d173-d427-e732241a6355@infradead.org>
Date:   Mon, 27 Apr 2020 12:31:39 -0700
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101
 Thunderbird/68.7.0
MIME-Version: 1.0
In-Reply-To: <20200427122606.dc29c381f6da47831a40d365@linux-foundation.org>
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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