linux-kernel - Re: [PATCH] bcachefs: mean and variance: fix kernel-doc for function params

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20231220074248.u4b6y73cyo7whucz@moria.home.lan>
Date: Wed, 20 Dec 2023 02:42:48 -0500
From: Kent Overstreet <kent.overstreet@...ux.dev>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Brian Foster <bfoster@...hat.com>,
	linux-bcachefs@...r.kernel.org
Subject: Re: [PATCH] bcachefs: mean and variance: fix kernel-doc for function
 params

On Tue, Dec 19, 2023 at 10:44:09PM -0800, Randy Dunlap wrote:
> 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 <rdunlap@...radead.org>
> Cc: Kent Overstreet <kent.overstreet@...ux.dev>
> Cc: Brian Foster <bfoster@...hat.com>
> Cc: linux-bcachefs@...r.kernel.org

Thanks, applied