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 3FC01C00140 for ; Thu, 18 Aug 2022 13:40:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239448AbiHRNkD (ORCPT ); Thu, 18 Aug 2022 09:40:03 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46696 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S245142AbiHRNjM (ORCPT ); Thu, 18 Aug 2022 09:39:12 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7D0D6578A9; Thu, 18 Aug 2022 06:39:10 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id BD701616BE; Thu, 18 Aug 2022 13:39:08 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id A5F2FC43155; Thu, 18 Aug 2022 13:39:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1660829947; bh=sHQpiOZeSDmvUKnpqLNeSpJ8k0is8v8/Gg2pA36gw7U=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=jm38uoNF9VUSOHOBbtQSsuEeNJle68s8xFWWxgP2bbJzecCtUQLM/yCdB9rwpo8Sj 6kw7AV675ZofxaINo6gCSAR0YPJpHCT/BU2d+ZvuCPWCjckjAEjUrn0jgMtTCPcZC6 NOW0vIBIkOEaaF5dfNajiXab6A4aHjJe7SPnXYY4Vj0CJfRIAdyTBsS6D5TXKb5vN2 aQ1bR3W9SX952CnZSLO5rpBK31F9LrWrDb0yu+28iNsIcBM48pWGdwAjYtkYCqOTH4 78d+V8G4uBBSGhXW0r8dLfaCz/8Pwk9GPlIqq5h9suCEnJgjOxtXKgvM8zqfm3m6Pv w7qYVDrioh2xQ== Received: from mchehab by mail.kernel.org with local (Exim 4.95) (envelope-from ) id 1oOfjl-00AY7t-K0; Thu, 18 Aug 2022 15:39:05 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , corbet@lwn.net Cc: Mauro Carvalho Chehab , David Howells , linux-cachefs@redhat.com, linux-kernel@vger.kernel.org Subject: [PATCH 11/13] fscache: fix kernel-doc markup on two functions Date: Thu, 18 Aug 2022 15:38:57 +0200 Message-Id: X-Mailer: git-send-email 2.37.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The obj parameter was replaced by a cookie. Update docs accordingly. It solves those doc build warnings: ./include/linux/fscache.h:270: warning: Function parameter or member 'cookie' not described in 'fscache_use_cookie' ./include/linux/fscache.h:270: warning: Excess function parameter 'object' description in 'fscache_use_cookie' ./include/linux/fscache.h:287: warning: Function parameter or member 'cookie' not described in 'fscache_unuse_cookie' ./include/linux/fscache.h:287: warning: Excess function parameter 'object' description in 'fscache_unuse_cookie' Signed-off-by: Mauro Carvalho Chehab --- See [PATCH 00/13] at: https://lore.kernel.org/all/cover.1660829433.git.mchehab@kernel.org/ 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..bc089ce2c903 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 to be attached * @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 to be unused * @aux_data: Updated auxiliary data (or NULL) * @object_size: Revised size of the object (or NULL) * -- 2.37.1