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 6F366C00140 for ; Thu, 18 Aug 2022 09:32:18 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241825AbiHRJcQ (ORCPT ); Thu, 18 Aug 2022 05:32:16 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37138 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233816AbiHRJcO (ORCPT ); Thu, 18 Aug 2022 05:32:14 -0400 Received: from out30-57.freemail.mail.aliyun.com (out30-57.freemail.mail.aliyun.com [115.124.30.57]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 13E509A954 for ; Thu, 18 Aug 2022 02:32:12 -0700 (PDT) X-Alimail-AntiSpam: AC=PASS;BC=-1|-1;BR=01201311R171e4;CH=green;DM=||false|;DS=||;FP=0|-1|-1|-1|0|-1|-1|-1;HT=ay29a033018046050;MF=jefflexu@linux.alibaba.com;NM=1;PH=DS;RN=4;SR=0;TI=SMTPD_---0VMaE0Lu_1660815129; Received: from 30.227.66.106(mailfrom:jefflexu@linux.alibaba.com fp:SMTPD_---0VMaE0Lu_1660815129) by smtp.aliyun-inc.com; Thu, 18 Aug 2022 17:32:10 +0800 Message-ID: <16a13735-1349-9927-0f7b-1c5622198e2a@linux.alibaba.com> Date: Thu, 18 Aug 2022 17:32:09 +0800 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:91.0) Gecko/20100101 Thunderbird/91.12.0 Subject: Re: [Linux-cachefs] [PATCH v2] fscache: fix misdocumented parameter Content-Language: en-US To: Khalid Masum , linux-cachefs@redhat.com, linux-kernel@vger.kernel.org Cc: Randy Dunlap References: <20220818040738.12036-1-khalid.masum.92@gmail.com> From: JeffleXu In-Reply-To: <20220818040738.12036-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 8/18/22 12:07 PM, Khalid Masum wrote: > This patch fixes two warnings generated by make docs. The functions > fscache_use_cookie and fscache_unuse_cookie, both have a parameter > named cookie. But they are documented with the name "object" with > unclear description. Which generates the warning when creating docs. > > This commit will replace the currently misdocumented parameter names > with the correct ones while adding proper descriptions. > > CC: Randy Dunlap > Signed-off-by: Khalid Masum LGTM. Reviewed-by: Jingbo Xu > --- > Changes since v1: > - Update commit message. > - Link: https://lore.kernel.org/lkml/20220521142446.4746-1-khalid.masum.92@gmail.com/ > > 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 720874e6ee94..36e5dd84cf59 100644 > --- a/include/linux/fscache.h > +++ b/include/linux/fscache.h > @@ -258,7 +258,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 > @@ -274,7 +274,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) > * -- Thanks, Jingbo