Received: by 2002:a05:6358:4e97:b0:b3:742d:4702 with SMTP id ce23csp448122rwb; Thu, 18 Aug 2022 06:42:43 -0700 (PDT) X-Google-Smtp-Source: AA6agR4rzD48tB7t3ZazGMLUw7BG9mH0xtnn6sv2u0C8Jy67/YDdBepagbnfFqm2KwB1gi4aRxF/ X-Received: by 2002:a05:6402:35c:b0:43c:8f51:130 with SMTP id r28-20020a056402035c00b0043c8f510130mr2304296edw.393.1660830163637; Thu, 18 Aug 2022 06:42:43 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1660830163; cv=none; d=google.com; s=arc-20160816; b=zBpwAAup5LFFzovuCbWQRhe0B3E6PLJILgSV4qpPz4ZAfXGDYywPpJ4LgJw0tCnRPN kUmeEWVNROyXtb/Qqz4T9Kffk4vqa4q7lq43qxtEUjkdq6K5n6nGkiD12AYP353OYBiQ 6K4HL+SXxT03eFd07MEl4LyN3EN1EoqNDqHh5U5qpquHjwQA/7vw6F/8zmfDJ1hoWdul nQ+abOer7sv16nHxAg2TqVjit226NQsgoExfGMKUkahy6vdYCTwKD6zlx4SOrF5wrLHQ gIiH0kG1pnT/otEM7PkSV8hRsnX0oc/2fcQ6PDm0VQfed9HzsP62Ttoycu5h3aRPTFBW RNaw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=xhvvMXL24MbmSVrbM6Bs6J2Go2wywVaLXA+rdXjz3DI=; b=aXXax1uie3zcaA8kyY0Zuzbiw/MOvp65Th5N4W4vGz+/56vqf2HP9J5+nMhjWUaVg7 BeAtrxjqEqhO1PigZoFFlM4LMF/G4LtkNOR2n72JmtF6pNUWNGE7aJEYiSseoZN1VJyw VlU0Rjpy5t79iW2av0b+VlzK5S5bRYQyBZ1YtBfmP1n3L3PZ8QzcR/U2i/cJ/2/T/gU1 xgc3YVUO4lvbdnDBTFkEtINkNbynTcdtuY/CGf9KKLtvF2EQN8tzOD0JXVpmM8hhQbcq 5kVPRhuqnqhUn/w+QCpPXivNlpxe39jdQHo3dE2P7oomt6n+0a+UdOM84SL+XJdE2W8T seqg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=jm38uoNF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id s1-20020aa7c541000000b0043c2919cfd3si1130666edr.602.2022.08.18.06.42.16; Thu, 18 Aug 2022 06:42:43 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=jm38uoNF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S245184AbiHRNkB (ORCPT + 99 others); Thu, 18 Aug 2022 09:40:01 -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 X-Spam-Status: No, score=-7.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_HI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net 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