From nobody Thu May 7 18:16:09 2026 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 67144C433EF for ; Sat, 21 May 2022 14:49:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230039AbiEUOtK (ORCPT ); Sat, 21 May 2022 10:49:10 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58766 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233791AbiEUOtF (ORCPT ); Sat, 21 May 2022 10:49:05 -0400 Received: from mail-pj1-x1033.google.com (mail-pj1-x1033.google.com [IPv6:2607:f8b0:4864:20::1033]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 917C66C57D for ; Sat, 21 May 2022 07:49:04 -0700 (PDT) Received: by mail-pj1-x1033.google.com with SMTP id nr2-20020a17090b240200b001df2b1bfc40so13767320pjb.5 for ; Sat, 21 May 2022 07:49:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=aEDSE1m+N2pYJdPG78Lh5a6q6esXpeyoa6uPZvrclFc=; b=kb9ZmcDvj5VJ4lpdrtpjOvjhyAPEsiwHmOCR2kpfa+vsxplXPgjOoutoI/rjKVNCPI KjcuKVWcB7a5bx2IsWpZAgRccdl9hlXyd4KiWlDkQQFrDWQ6qMbsP6kyckc20/R3pl6k xG/as0Q0yWJPpSNOv3DOchIHTJKgOJky9HM+ky9R7OHfyDjGMELp2OAWlj6mleMd8nvf 7oyeVqweqCAKuWjXMwiLF9R/u9v3L73AokJnkWJLCAoMSPIghQcH8OtknirTtdDOz+IW H3EGKIXfm7zDx4PYPID7ajjiPdtWQNmUGZ8jBNcCZEPWP1Svn92DCcABxqKEHiYl8FpN N1zw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=aEDSE1m+N2pYJdPG78Lh5a6q6esXpeyoa6uPZvrclFc=; b=rymITZVqsXPEnTk1tbThLqIeyG9Wq+wkZkbI8B9542OEZlewyTyaOikJFn3OxQJeFn /iVnvXfv1ZufbHjZdJVuJRJsJ143GTBj6dk3zB5z9YkcGxaP4qA3GhKzdrIGeXEv6+/D ho6uzXJzZlhclpWGsJTx8sJSLreasBlf6TVYy2rzubj8K+KCgQS78vnYwEJl4OdFSTiW uRfKaoE0eAZTyVyJGQ1QlqwAj8dwBfIIWmNpwJmb88w6mBFnlg/FtFW6rYgJ7Z+IjpDs KEMJ+OAvoW7q7rgl6M8WEAQNlR5TunfMp8yyJ8k0rnKlMaD303WunVDTbraft9Pe4xY0 eI1A== X-Gm-Message-State: AOAM532YPOcd6zz+LeR3vwejvmlOttrKYaBeUM0yVIe84URBiE2Gchdg JmCVYIYbO1w0HoSp/uQ2OkU= X-Google-Smtp-Source: ABdhPJweIG1odMEjxkG19mhDsemgTmxJXjxh0vDN9QHxD5/5kjm6SG9klmp/njsu9QE2v3z4H44UXg== X-Received: by 2002:a17:90a:a384:b0:1dc:a407:b5ac with SMTP id x4-20020a17090aa38400b001dca407b5acmr16585135pjp.11.1653144544094; Sat, 21 May 2022 07:49:04 -0700 (PDT) Received: from localhost.localdomain ([103.230.104.50]) by smtp.gmail.com with ESMTPSA id g8-20020a17090a290800b001dc4d22c0a7sm3709572pjd.10.2022.05.21.07.49.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 21 May 2022 07:49:03 -0700 (PDT) From: Khalid Masum To: linux-kernel-mentees@lists.linuxfoundation.org Cc: Shuah Khan , David Howells , linux-cachefs@redhat.com, linux-kernel@vger.kernel.org, Khalid Masum Subject: [PATCH] fscache: fix misdocumented parameter name Date: Sat, 21 May 2022 20:24:46 +0600 Message-Id: <20220521142446.4746-1-khalid.masum.92@gmail.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" 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 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 fs= cache_volume *volume, =20 /** * 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 t= ell @@ -272,7 +272,7 @@ static inline void fscache_use_cookie(struct fscache_co= okie *cookie, =20 /** * 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) * --=20 2.25.1