From nobody Wed Apr 8 01:18:01 2026 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 0AF4330CD9E for ; Wed, 11 Mar 2026 05:23: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=1773206639; cv=none; b=TVA5mFFqE2iwWnqSGYCS04R8rCBdZf03rt87EbNEtouBleY9rLm0BFS/lnCHRFzAJ/KT/rkyLIVdfVUm8L4PvfqSzeYvrRgKaOpjUGzf1fGY2s0iTfrdur6+Xqf+hJ5MTYh7ionUp3WZe/yBxAaoVSLdtBr/QE/UAYMIuDuyAwM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773206639; c=relaxed/simple; bh=su7UCjuf5+iuWMLNEuwlOITYnE8ZPIU+UHfIj6AaxN0=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=bvb5DmBOY6WNg2XYZoYi4u9nYt2T63UJ6pa+FPM1nqp3NU8fWKX9/lruhrtnmsfmmZzztS9ZU1ZFrUmf/4ui4dH4QKgL9E0Nmz+xY1eR7UGGCA5RtegGtXo2pSU0nS/pIrTzz04hnPQ5Kk7WVE/sBUFKzeHWmC/4M+GFKDhtxh4= 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=KvuJAIMh; 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="KvuJAIMh" 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=7nVOfW0h2EIf1vGj6CiiGV71jK91R5pSWS6j/JwJT/g=; b=KvuJAIMhO6tc+oPRrV+I3pYePH /Xy3UPIXrz4jwMJEKaiD6PEKnjijqYLnjyOsDv5fXPOvm/WSk//HktWGziv3DcXqCH0q7XrH17k1z 0X4RQLaYVLFQYrNmSoV7UZXoRwieul8HafudbelgXqoi/MZ7oqNf349M+ZVEjYjRqCKPx659s5Trh LBtnRwyCzSAv66+3qyjNSTXpMHb6+YIU1dKfBegTHyTfq9PDdi3YEdabLSZIzncc2Fw+2hTYkSQ0+ zWD2BYIhTN/xuo/d9FIZ+1VPi/sELaroxp+b2syCb2d3hj02PTh8Kbtk+dRbBI34tx+4ouktvOa15 QB15OqKg==; 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 1w0C32-0000000Am2h-1g1a; Wed, 11 Mar 2026 05:23:56 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , "Jason A. Donenfeld" Subject: [PATCH] siphash: clean up kernel-doc comments Date: Tue, 10 Mar 2026 22:23:55 -0700 Message-ID: <20260311052355.305663-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.53.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Use the correct function parameter names and add function return value descriptions to avoid kernel-doc warnings: Warning: include/linux/siphash.h:82 function parameter 'len' not described in 'siphash' Warning: include/linux/siphash.h:82 No description found for return value of 'siphash' Warning: include/linux/siphash.h:132 function parameter 'len' not described in 'hsiphash' Warning: include/linux/siphash.h:132 No description found for return value of 'hsiphash' Signed-off-by: Randy Dunlap --- Cc: Jason A. Donenfeld include/linux/siphash.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) --- linux-next-20260309.orig/include/linux/siphash.h +++ linux-next-20260309/include/linux/siphash.h @@ -75,8 +75,10 @@ static inline u64 ___siphash_aligned(con /** * siphash - compute 64-bit siphash PRF value * @data: buffer to hash - * @size: size of @data + * @len: size of @data * @key: the siphash key + * + * Returns: siphash PRF value */ static inline u64 siphash(const void *data, size_t len, const siphash_key_t *key) @@ -125,8 +127,10 @@ static inline u32 ___hsiphash_aligned(co /** * hsiphash - compute 32-bit hsiphash PRF value * @data: buffer to hash - * @size: size of @data + * @len: size of @data * @key: the hsiphash key + * + * Returns: hsiphash PRF value */ static inline u32 hsiphash(const void *data, size_t len, const hsiphash_key_t *key)