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 3366AC433F5 for ; Sat, 21 May 2022 15:32:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S245125AbiEUPcR (ORCPT ); Sat, 21 May 2022 11:32:17 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37360 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230448AbiEUPcN (ORCPT ); Sat, 21 May 2022 11:32:13 -0400 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 64A632AE23 for ; Sat, 21 May 2022 08:32:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; 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=W4TUiEIdq5HcuLZw5jcWt2qZJ3RX3G8mxdh0nA1JeNU=; b=i548B275KQ2uVw/gK+rQS7z83v 7ywiroVH4OOObHSfKdxZ9yjAn5ePtZfG0DwPCXbnp8N7FfeJrHs8pvTPhFKHQedQV/69LXFqf6/Da IVc76CWnsVlJa3/b+t3XLIKFqdAUCmmtAU1qa1ndxLN5l2A9p/kw4c5zEH3kuysBYjmnFe/37ubmI v+HV2QUdjyV6xunUXTotgYL5GBR0xoyDMO7ti5lYzftAVGt9Btpn8BjvVd0qHjrZ0x8A7YFUYjdqP D3qB5sATLmsxWT8k5cfbsEirYBD3cXKLqloJenajbnI7NdCKZRzB34ISvIK8ihIekcAMVxfNhYJLE 5xod/fdw==; Received: from [2601:1c0:6280:3f0::aa0b] by casper.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1nsR5D-00EjdF-Jk; Sat, 21 May 2022 15:31:59 +0000 Message-ID: Date: Sat, 21 May 2022 08:31:54 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.9.0 Subject: Re: [PATCH] fscache: fix misdocumented parameter name Content-Language: en-US To: Khalid Masum , linux-kernel-mentees@lists.linuxfoundation.org Cc: Shuah Khan , David Howells , linux-cachefs@redhat.com, linux-kernel@vger.kernel.org References: <20220521142446.4746-1-khalid.masum.92@gmail.com> From: Randy Dunlap In-Reply-To: <20220521142446.4746-1-khalid.masum.92@gmail.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 5/21/22 07:24, Khalid Masum wrote: > To fix warning generated by make docs in the file fscache.h: > The functions fscache_use_cookie and fscache_unuse_cookie have a > parameter named cookie. But they are documented with the name "object". > Which generates warning when creating docs. This commit will replace > the documentation with a better one named "cookie". This new > documentation > line is taken from the function fscache_update_cookie in the same > file. > > Signed-off-by: Khalid Masum LGTM. Thanks. Reviewed-by: Randy Dunlap > --- > include/linux/fscache.h | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/include/linux/fscache.h b/include/linux/fscache.h > index e25539072..32cf593b8 100644 > --- a/include/linux/fscache.h > +++ b/include/linux/fscache.h > @@ -256,7 +256,7 @@ struct fscache_cookie *fscache_acquire_cookie(struct fscache_volume *volume, > > /** > * fscache_use_cookie - Request usage of cookie attached to an object > - * @object: Object description > + * @cookie: The cookie representing the cache object > * @will_modify: If cache is expected to be modified locally > * > * Request usage of the cookie attached to an object. The caller should tell > @@ -272,7 +272,7 @@ static inline void fscache_use_cookie(struct fscache_cookie *cookie, > > /** > * fscache_unuse_cookie - Cease usage of cookie attached to an object > - * @object: Object description > + * @cookie: The cookie representing the cache object > * @aux_data: Updated auxiliary data (or NULL) > * @object_size: Revised size of the object (or NULL) > * -- ~Randy 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 smtp3.osuosl.org (smtp3.osuosl.org [140.211.166.136]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 5C623C433F5 for ; Sat, 21 May 2022 15:32:09 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id F090B60BA8; Sat, 21 May 2022 15:32:08 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 3lpoVJNGpOVS; Sat, 21 May 2022 15:32:07 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [IPv6:2605:bc80:3010:104::8cd3:938]) by smtp3.osuosl.org (Postfix) with ESMTPS id D4CEE60A82; Sat, 21 May 2022 15:32:06 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id A83ACC0032; Sat, 21 May 2022 15:32:06 +0000 (UTC) Received: from smtp3.osuosl.org (smtp3.osuosl.org [IPv6:2605:bc80:3010::136]) by lists.linuxfoundation.org (Postfix) with ESMTP id AE94BC002D for ; Sat, 21 May 2022 15:32:05 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id A6FA160BA3 for ; Sat, 21 May 2022 15:32:05 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 5Qb6KVsHyo1P for ; Sat, 21 May 2022 15:32:04 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.8.0 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by smtp3.osuosl.org (Postfix) with ESMTPS id 8CF7C60A82 for ; Sat, 21 May 2022 15:32:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; 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=W4TUiEIdq5HcuLZw5jcWt2qZJ3RX3G8mxdh0nA1JeNU=; b=i548B275KQ2uVw/gK+rQS7z83v 7ywiroVH4OOObHSfKdxZ9yjAn5ePtZfG0DwPCXbnp8N7FfeJrHs8pvTPhFKHQedQV/69LXFqf6/Da IVc76CWnsVlJa3/b+t3XLIKFqdAUCmmtAU1qa1ndxLN5l2A9p/kw4c5zEH3kuysBYjmnFe/37ubmI v+HV2QUdjyV6xunUXTotgYL5GBR0xoyDMO7ti5lYzftAVGt9Btpn8BjvVd0qHjrZ0x8A7YFUYjdqP D3qB5sATLmsxWT8k5cfbsEirYBD3cXKLqloJenajbnI7NdCKZRzB34ISvIK8ihIekcAMVxfNhYJLE 5xod/fdw==; Received: from [2601:1c0:6280:3f0::aa0b] by casper.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1nsR5D-00EjdF-Jk; Sat, 21 May 2022 15:31:59 +0000 Message-ID: Date: Sat, 21 May 2022 08:31:54 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.9.0 Subject: Re: [PATCH] fscache: fix misdocumented parameter name Content-Language: en-US To: Khalid Masum , linux-kernel-mentees@lists.linuxfoundation.org References: <20220521142446.4746-1-khalid.masum.92@gmail.com> From: Randy Dunlap In-Reply-To: <20220521142446.4746-1-khalid.masum.92@gmail.com> Cc: David Howells , linux-cachefs@redhat.com, linux-kernel@vger.kernel.org X-BeenThere: linux-kernel-mentees@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-kernel-mentees-bounces@lists.linuxfoundation.org Sender: "Linux-kernel-mentees" On 5/21/22 07:24, Khalid Masum wrote: > To fix warning generated by make docs in the file fscache.h: > The functions fscache_use_cookie and fscache_unuse_cookie have a > parameter named cookie. But they are documented with the name "object". > Which generates warning when creating docs. This commit will replace > the documentation with a better one named "cookie". This new > documentation > line is taken from the function fscache_update_cookie in the same > file. > > Signed-off-by: Khalid Masum LGTM. Thanks. Reviewed-by: Randy Dunlap > --- > include/linux/fscache.h | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/include/linux/fscache.h b/include/linux/fscache.h > index e25539072..32cf593b8 100644 > --- a/include/linux/fscache.h > +++ b/include/linux/fscache.h > @@ -256,7 +256,7 @@ struct fscache_cookie *fscache_acquire_cookie(struct fscache_volume *volume, > > /** > * fscache_use_cookie - Request usage of cookie attached to an object > - * @object: Object description > + * @cookie: The cookie representing the cache object > * @will_modify: If cache is expected to be modified locally > * > * Request usage of the cookie attached to an object. The caller should tell > @@ -272,7 +272,7 @@ static inline void fscache_use_cookie(struct fscache_cookie *cookie, > > /** > * fscache_unuse_cookie - Cease usage of cookie attached to an object > - * @object: Object description > + * @cookie: The cookie representing the cache object > * @aux_data: Updated auxiliary data (or NULL) > * @object_size: Revised size of the object (or NULL) > * -- ~Randy _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees