linux-kernel - Re: [PATCH] userns: eliminate many kernel-doc warnings

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: <20231109-amtszeit-geurteilt-89cadab33960@brauner>
Date:   Thu,  9 Nov 2023 10:20:10 +0100
From:   Christian Brauner <brauner@...nel.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     Christian Brauner <brauner@...nel.org>, patches@...ts.linux.dev,
        Eric Biederman <ebiederm@...ssion.com>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] userns: eliminate many kernel-doc warnings

On Wed, 30 Aug 2023 09:32:15 -0700, Randy Dunlap wrote:
> Drop the kernel-doc "/**" notation from 8 structs or functions to
> prevent 22 kernel-doc warnings  (samples below).
> 
> user_namespace.c:239: warning: Function parameter or member 'map_up' not described in 'idmap_key'
> user_namespace.c:246: warning: Function parameter or member 'k' not described in 'cmp_map_id'
> user_namespace.c:277: warning: Function parameter or member 'extents' not described in 'map_id_range_down_max'
> user_namespace.c:295: warning: Function parameter or member 'extents' not described in 'map_id_range_down_base'
> user_namespace.c:344: warning: Function parameter or member 'extents' not described in 'map_id_up_base'
> user_namespace.c:364: warning: Function parameter or member 'extents' not described in 'map_id_up_max'
> user_namespace.c:776: warning: Function parameter or member 'map' not described in 'insert_extent'
> user_namespace.c:844: warning: Function parameter or member 'map' not described in 'sort_idmaps'
> 
> [...]

Applied to the vfs.misc branch of the vfs/vfs.git tree.
Patches in the vfs.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.misc

[1/1] userns: eliminate many kernel-doc warnings
      https://git.kernel.org/vfs/vfs/c/97966f21d3d4