From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0C8FEC19F2A for ; Thu, 11 Aug 2022 18:33:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235650AbiHKSdM (ORCPT ); Thu, 11 Aug 2022 14:33:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41854 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235632AbiHKSdK (ORCPT ); Thu, 11 Aug 2022 14:33:10 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D6307979D4 for ; Thu, 11 Aug 2022 11:33:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date: Message-ID:Sender:Reply-To:Content-ID:Content-Description; bh=gfUgkm3rzFm3+JeLSBJ3gUUgraDOnG1hTppcWY/3fRE=; b=Nb8yyTjFgFtJpVzA3oJSn6vxUF 5Z1m34AVhJzxQ60civQFB8gMO6v8DGnygeVIYHjNsx5yxxoAXVjhTyyFrqAa0zKuMjwmnrWlhVR67 GRtnmP3eXChzWUfOWWTYIAZeqGpkloe9pxp0sbvWVRSUMcQYvvqIdCatpiPrBlUEb2u02+74q81qG aZkf3VNQyIQwat8V6CnjCqtKP7SwSIHIT74m7fAn1PWdRDEQUcvKTcwe1ZnlVhoV9n6EqI2DR61U0 YQP5nS+g80LFQLl8erHPeR3NeV4VkCRROg+jM/SZZChkrPfqk/4UVZgfVr4MC4zHTMJ31vOGkkWHJ FdSRFJRA==; Received: from c-73-157-219-8.hsd1.or.comcast.net ([73.157.219.8] helo=[10.0.0.152]) by bombadil.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1oMCzR-0000Yo-JC; Thu, 11 Aug 2022 18:33:05 +0000 Message-ID: Date: Thu, 11 Aug 2022 11:33:04 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.11.0 Subject: Re: [PATCH] Doc fix for dget_dlock Content-Language: en-US To: Anup Parikh Cc: skhan@linuxfoundation.org, linux-kernel@vger.kernel.org References: <98fe1c6d-9528-05b5-c603-fb4ae028a19c@infradead.org> From: Randy Dunlap In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi-- On 8/11/22 07:48, Anup Parikh wrote: > Hello Mr. Randy Dunlap, > > I checked include/linux/dcache.h (dget() and dget_dlock()), include/linux/lockref.h and linux/lib/lockref.c. > My current knowledge is limited but I think: > 1) dget_dlock() directly increments the count variable without any atomicity guards. > 2) dget() does the same but with atomicity guarantee - even across multiple-cores on a multi-core system (according to https://stackoverflow.com/questions/36964478/understanding-synchronization-with-multiple-processors and code in linux/lib/lockref.c). > > Please let me know if I should write the corresponding documentation and send a new patch. Yes, please. Thanks. > Thanks and Regards, > Anup K Parikh. > > > On Tue, Aug 9, 2022 at 11:58 PM Randy Dunlap > wrote: > > Hi-- > > On 8/5/22 09:39, Anup K Parikh wrote: > > Removes the warning for dget_dlock in include/linux/dcache.h and > > enables generation of its API documentation > > > > Signed-off-by: Anup K Parikh > > > --- > >  include/linux/dcache.h | 2 +- > >  1 file changed, 1 insertion(+), 1 deletion(-) > > > > diff --git a/include/linux/dcache.h b/include/linux/dcache.h > > index f5bba5148..ce0b36f72 100644 > > --- a/include/linux/dcache.h > > +++ b/include/linux/dcache.h > > @@ -297,7 +297,7 @@ extern char *dentry_path(const struct dentry *, char *, int); > >  /* Allocation counts.. */ > >  > >  /** > > - *   dget, dget_dlock -      get a reference to a dentry > > + *   dget_dlock -    get a reference to a dentry > >   *   @dentry: dentry to get a reference to > >   * > >   *   Given a dentry or %NULL pointer increment the reference count > > Someone was trying to document both dget() and get_dlock() with the same > kernel-doc comment block. > I suppose that you could duplicate the comments for dget() also. > > It would be nice to know the difference(s) in the functions as well. > > thanks. > -- > ~Randy > -- ~Randy