From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 57EF1DDC5; Mon, 2 Mar 2026 00:51:56 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1772412717; cv=none; b=ey0klRXxZlp3iDhB0XcB6BxGbHXT3V5D4/i00NYsfCVxcB9hxa/E1P5HdYDJVWyTtVPglM6HtnlgqAReaWVY6LAzfBrM9HpbtVidnBzmA1tsOKqNVymiauTUcy1M6vM/T22SI7AbXYio1VrB6J82ouC39ewpIfOmOcE1S+53Z6I= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1772412717; c=relaxed/simple; bh=gEnZzOPlr/pGSdp2NBRsYp0+b2CQTTTgpenMn0guDwI=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=ekzwQBDNCZlJe1tRcVRkqYHMtSY19hwE5rIdmlW6b9r29BipZmF04a9++VWfcOM3dvaRdhXEwbpGHAcZbBNBCBE1FTnoLgoPKlDjEbEYRNKl3CEova5Bp58bcHasW/GnhJ6b6IH+DlhZmlo7s6eYHntiQ0fDL9BFfFGE3KsasXA= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=vqd3AUSC; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="vqd3AUSC" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=3K8zpBQg3FXVAxGmjdQ7iDBhiF4rMaXTwVkx5Jp15TE=; b=vqd3AUSCi/N47AQsZtURUJWjPi xp67zhLM01jPIpTXnwSv8K7mKAi1IKeJPiSqU7an9c8wa5OFvySoqDGnjLnFpqkVE/aEa0lvv6rq9 3kdzp7NymTNWl1Pvbze61X7BOj7AG0B5GuZf5sc/X3Y0pWUxtMY9DB2sR/UyJXKEfm28romj8Yqfj 1zHP/2b1ugcf7GHzu6kanuo6O4tLWBpdsEyODEtB28ZK2khsOhj8nRf86m0LaCsZ3fUgHFzysBcb/ HTSiVBF5+7YlXS9hPB6N81XRoDqkBaz8Fgbl6L+Bd/r5gyOk4Kv+UJGUKE524wrx6qEYxhYg28q3M gw/su6mA==; Received: from [50.53.43.113] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.98.2 #2 (Red Hat Linux)) id 1vwrVr-0000000C27R-1Mnx; Mon, 02 Mar 2026 00:51:55 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Paul Moore , Serge Hallyn , linux-security-module@vger.kernel.org Subject: [PATCH] cred: cred.h: fix kernel-doc warnings Date: Sun, 1 Mar 2026 16:51:54 -0800 Message-ID: <20260302005154.3468238-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.53.0 Precedence: bulk X-Mailing-List: linux-security-module@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Use the correct function parameter names, function names, or kernel-doc format, and add function return comment sections to avoid kernel-doc warnings: Warning: include/linux/cred.h:43 function parameter 'gi' not described in 'get_group_info' Warning: include/linux/cred.h:43 No description found for return value of 'get_group_info' Warning: include/linux/cred.h:213 No description found for return value of 'get_cred_many' Warning: include/linux/cred.h:260 function parameter '_cred' not described in 'put_cred_many' Warning: include/linux/cred.h:260 expecting prototype for put_cred(). Prototype was for put_cred_many() instead Signed-off-by: Randy Dunlap --- Cc: Paul Moore Cc: Serge Hallyn Cc: linux-security-module@vger.kernel.org include/linux/cred.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) --- linux-next-20260227.orig/include/linux/cred.h +++ linux-next-20260227/include/linux/cred.h @@ -33,12 +33,14 @@ struct group_info { /** * get_group_info - Get a reference to a group info structure - * @group_info: The group info to reference + * @gi: The group info to reference * * This gets a reference to a set of supplementary groups. * * If the caller is accessing a task's credentials, they must hold the RCU read * lock when reading. + * + * Returns: @gi */ static inline struct group_info *get_group_info(struct group_info *gi) { @@ -209,6 +211,8 @@ DEFINE_CLASS(override_creds, * usage count. The purpose of this is to attempt to catch at compile time the * accidental alteration of a set of credentials that should be considered * immutable. + * + * Returns: @cred when the references are acquired, NULL otherwise. */ static inline const struct cred *get_cred_many(const struct cred *cred, int nr) { @@ -246,8 +250,8 @@ static inline const struct cred *get_cre } /** - * put_cred - Release a reference to a set of credentials - * @cred: The credentials to release + * put_cred_many - Release a reference to a set of credentials + * @_cred: The credentials to release * @nr: Number of references to release * * Release a reference to a set of credentials, deleting them when the last ref