From patchwork Wed Dec 20 06:44:09 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 181482 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:24d3:b0:fb:cd0c:d3e with SMTP id r19csp2456098dyi; Tue, 19 Dec 2023 22:45:59 -0800 (PST) X-Google-Smtp-Source: AGHT+IHlptmRpmByHriRKOhXxicpp72j+GrfQX3YZKhKLc2fl2DXGuTAc6pPP8wVMyfbLXoN0qDn X-Received: by 2002:a9d:68d6:0:b0:6b7:4a52:a33a with SMTP id i22-20020a9d68d6000000b006b74a52a33amr16919891oto.14.1703054759581; Tue, 19 Dec 2023 22:45:59 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703054759; cv=none; d=google.com; s=arc-20160816; b=a5to2uxpB7UEdILEaIfGBcOEmsgiTTbyG1nMz4v2tq2kgZdpuDHzcpOuCVNk9TRDXe rwhwowg0/WkWEpBUYkvC0j77rz5AlLR+jhWAQIJ8ZH9D48AZgMAQYKoGLjTgzZM2h9WY 0+neXeLuUO0xdVXWIeghc40eOodf1ielooeadsd+lcKeMGluO4iCzCRHQwpnD31N3Zxv jbq2QwZvM7jT3LRmQ4qPBqjR22C60IKR/uduc9RSGMtzWMir1DgkH4O4wZHw+AFJ/7zh tivko6V75ocJeWcpqlZrCDvZHO69w1x2+puC2prFvfaJq4eOzxOyvitCUC3zTldLssil XdHw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=yJ+oDqG2zmO444SiJyKceB+qxN8npAMGhcgnHq7cw2A=; fh=OWdsSsRi6T/rsHbYeqPBlq6diQzXTLLUYmeFzaafKZM=; b=EC0X+A+gb3bswIHP+0cORlneHiPjXrslGof/sdKCcw2g2ovW2MMbrFUfe7+oEn7zw2 QTqf50xSjYV7WQslIi8TSPmAJQ8JLbHicVwGXM5c8nTdH20vvNvVWZ4wGwfunDNAHOm1 NTFa2ZRYg0i7ocfIGaJekH5MFHCZYjFlwGQdJLrE5CI3ds6PX++cgp29FBPRhk72lLJv gRYyJY1VidFDZhjTX7UDBGgcqy/Wy5fLH4Oy71rK3J5UINAxy10ITQE5QvDZZoefWmoq RHD65h7BD45HTqcBqE+xyIC73VF8v0aufF2+fqg884QCIjhV99cF2a8EGFPwvKRJPttF 6kGw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=e72hiog8; spf=pass (google.com: domain of linux-kernel+bounces-6432-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-6432-ouuuleilei=gmail.com@vger.kernel.org" Received: from sy.mirrors.kernel.org (sy.mirrors.kernel.org. [2604:1380:40f1:3f00::1]) by mx.google.com with ESMTPS id u12-20020a6540cc000000b005ca1c765c26si15618791pgp.640.2023.12.19.22.45.59 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 19 Dec 2023 22:45:59 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-6432-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=e72hiog8; spf=pass (google.com: domain of linux-kernel+bounces-6432-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-6432-ouuuleilei=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by sy.mirrors.kernel.org (Postfix) with ESMTPS id 33B37B22DAB for ; Wed, 20 Dec 2023 06:44:31 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 853DD1C2A0; Wed, 20 Dec 2023 06:44:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="e72hiog8" X-Original-To: linux-kernel@vger.kernel.org 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 9222418E02; Wed, 20 Dec 2023 06:44:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org 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=yJ+oDqG2zmO444SiJyKceB+qxN8npAMGhcgnHq7cw2A=; b=e72hiog84p+r45gw6hgXKxK5sH 4rwkXx/QGErqNyZsbKkY5fYwF05//8+VeIGIetiChkvfb4WY8YOZIlEma7tMCkAMAxJdd162Nmfp+ MXB/qa6/HjHEXUsabbN9cTDowt5FkkYJA7PmKh/fz2qkynmhgfZDVh2MnH4yBAfiTGGv6oW4G7Td8 4pirO8A/FzsIaLfiGWx0Xc8AopRIDhdoaK6r3gCSr0z2UMPF2sX/Nh/50V9xtBxFkbUZRMWqsC2yE /7gQPAo4oSczBCfrll2nmb32pj/5+LCOUvILTeWBeMJlyEP0c+Cx2KxhnL3/ri/2hmrrKcdnEF5Ds POslinEQ==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rFqJN-00GKFj-1v; Wed, 20 Dec 2023 06:44:09 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Kent Overstreet , Brian Foster , linux-bcachefs@vger.kernel.org Subject: [PATCH] bcachefs: mean and variance: fix kernel-doc for function params Date: Tue, 19 Dec 2023 22:44:09 -0800 Message-ID: <20231220064409.12161-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785782347452911317 X-GMAIL-MSGID: 1785782347452911317 Add missing function parameter descriptions in mean_and_variance.c. The also eliminates the "Excess function parameter" warnings. Prevents these kernel-doc warnings: mean_and_variance.c:67: warning: Function parameter or member 's' not described in 'mean_and_variance_get_mean' mean_and_variance.c:78: warning: Function parameter or member 's1' not described in 'mean_and_variance_get_variance' mean_and_variance.c:94: warning: Function parameter or member 's' not described in 'mean_and_variance_get_stddev' mean_and_variance.c:108: warning: Function parameter or member 's' not described in 'mean_and_variance_weighted_update' mean_and_variance.c:108: warning: Function parameter or member 'x' not described in 'mean_and_variance_weighted_update' mean_and_variance.c:108: warning: Excess function parameter 's1' description in 'mean_and_variance_weighted_update' mean_and_variance.c:108: warning: Excess function parameter 's2' description in 'mean_and_variance_weighted_update' mean_and_variance.c:134: warning: Function parameter or member 's' not described in 'mean_and_variance_weighted_get_mean' mean_and_variance.c:143: warning: Function parameter or member 's' not described in 'mean_and_variance_weighted_get_variance' mean_and_variance.c:153: warning: Function parameter or member 's' not described in 'mean_and_variance_weighted_get_stddev' Signed-off-by: Randy Dunlap Cc: Kent Overstreet Cc: Brian Foster Cc: linux-bcachefs@vger.kernel.org --- fs/bcachefs/mean_and_variance.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff -- a/fs/bcachefs/mean_and_variance.c b/fs/bcachefs/mean_and_variance.c --- a/fs/bcachefs/mean_and_variance.c +++ b/fs/bcachefs/mean_and_variance.c @@ -62,6 +62,7 @@ EXPORT_SYMBOL_GPL(u128_div); /** * mean_and_variance_get_mean() - get mean from @s + * @s: mean and variance number of samples and their sums */ s64 mean_and_variance_get_mean(struct mean_and_variance s) { @@ -71,6 +72,7 @@ EXPORT_SYMBOL_GPL(mean_and_variance_get_ /** * mean_and_variance_get_variance() - get variance from @s1 + * @s1: mean and variance number of samples and sums * * see linked pdf equation 12. */ @@ -89,6 +91,7 @@ EXPORT_SYMBOL_GPL(mean_and_variance_get_ /** * mean_and_variance_get_stddev() - get standard deviation from @s + * @s: mean and variance number of samples and their sums */ u32 mean_and_variance_get_stddev(struct mean_and_variance s) { @@ -98,8 +101,8 @@ EXPORT_SYMBOL_GPL(mean_and_variance_get_ /** * mean_and_variance_weighted_update() - exponentially weighted variant of mean_and_variance_update() - * @s1: .. - * @s2: .. + * @s: mean and variance number of samples and their sums + * @x: new value to include in the &mean_and_variance_weighted * * see linked pdf: function derived from equations 140-143 where alpha = 2^w. * values are stored bitshifted for performance and added precision. @@ -129,6 +132,7 @@ EXPORT_SYMBOL_GPL(mean_and_variance_weig /** * mean_and_variance_weighted_get_mean() - get mean from @s + * @s: mean and variance number of samples and their sums */ s64 mean_and_variance_weighted_get_mean(struct mean_and_variance_weighted s) { @@ -138,6 +142,7 @@ EXPORT_SYMBOL_GPL(mean_and_variance_weig /** * mean_and_variance_weighted_get_variance() -- get variance from @s + * @s: mean and variance number of samples and their sums */ u64 mean_and_variance_weighted_get_variance(struct mean_and_variance_weighted s) { @@ -148,6 +153,7 @@ EXPORT_SYMBOL_GPL(mean_and_variance_weig /** * mean_and_variance_weighted_get_stddev() - get standard deviation from @s + * @s: mean and variance number of samples and their sums */ u32 mean_and_variance_weighted_get_stddev(struct mean_and_variance_weighted s) {